调用DescribeFabricExplorer来浏览Fabric账本相关的信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeFabricExplorer |
系统规定参数。取值:DescribeFabricExplorer。 |
RegionId | String | 否 | cn-hangzhou |
区域ID |
OrganizationId | String | 是 | peers-test11-tzwny25vqicq |
组织ID |
ExMethod | String | 是 | GET |
请求方法 |
ExUrl | String | 是 | /api/v1/channel |
请求URL |
ExBody | String | 是 | {} |
请求体(注:保留使用) |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 19E91C1D-9BD0-468F-A7DA-915263C6689F |
请求ID |
Result | String | {} |
返回可转换成JSON的字符串 |
Success | Boolean | true |
返回状态 |
ErrorCode | Integer | 200 |
返回代码 |
DynamicMessage | String | An error in the monitoring service has occurred. |
错误消息 |
DynamicCode | String | ExplorerException |
错误代码 |
示例
请求示例
# 获取当前服务端支持API版本信息,从v2版本开始支持
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api&<公共请求参数>
# 获取所有通道信息
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api/v1/channel&<公共请求参数>
# 获取通道名为:channel的通道信息
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api/v1/channel/:channel&<公共请求参数>
# 获取通道名为:channel的通道中block信息。limit表示最大获取block数量,offset表示获取的起始block,从0开始,可以为负整数
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api/v1/channel/:channel/block?limit=${limit}&offset=${offset}&<公共请求参数>
# 获取通道名为:channel的通道中:block信息,:block为blockId或blockHash
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api/v1/channel/:channel/block/:block&<公共请求参数>
# 获取通道名为:channel的通道中:tx信息
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api/v1/channel/:channel/tx/:tx&<公共请求参数>
# 获取通道名为:channel的通道中的metric信息
# :precision为minute或hour,表示按分钟或小时计算metric
# :type为block或tx,表示按block或tx计算metric
# ${left}和${right}表示获取metric的时间区间,格式满足js => new Date(${left | right})即可。
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api/v1/channel/:channel/metric/:precision/:type?left=${left}&right=${right}&<公共请求参数>
# 获取当前通道的背书统计信息
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api/v2/channel/:channel/statistics/endorser&<公共请求参数>
# 获取当前通道的链码统计信息
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api/v2/channel/:channel/statistics/chaincode&<公共请求参数>
# 获取当前通道中被验证通过交易统计信息
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api/v2/channel/:channel/statistics/result&<公共请求参数>
# 获取当前通道中交易发起用户的统计信息
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api/v2/channel/:channel/statistics/creator&<公共请求参数>
# 获取当前通道下链码的背书统计信息
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api/v2/channel/:channel/statistics/chaincode/:chaincode/endorser&<公共请求参数>
# 获取当前通道下链码中被验证通过交易统计信息
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api/v2/channel/:channel/statistics/chaincode/:chaincode/result&<公共请求参数>
# 获取当前通道下链码中交易发起用户的统计信息
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api/v2/channel/:channel/statistics/chaincode/:chaincode/creator&<公共请求参数>
# 获取当前通道下链码的函数调用统计信息
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api/v2/channel/:channel/statistics/chaincode/:chaincode/function&<公共请求参数>
# 获取当前通道下链码的函数版本统计信息
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api/v2/channel/:channel/statistics/chaincode/:chaincode/version&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeFabricExplorerResponse>
<RequestId>AB2560A0-EF98-462D-B9BA-D422206B94B3</RequestId>
<ErrorCode>200</ErrorCode>
<Success>true</Success>
<Result>{}</Result>
</DescribeFabricExplorerResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "AB2560A0-EF98-462D-B9BA-D422206B94B3",
"ErrorCode" : 200,
"Success" : true,
"Result" : "{}"
}