You can call this operation to view the Fabric ledger information.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeFabricExplorer

The operation that you want to perform. Set the value to DescribeFabricExplorer.

ExMethod String Yes GET

The request method.

OrganizationId String Yes peers-test11-tzwny25vqicq

The ID of the organization.

ExBody String No {}

The request body (reserved).

ExUrl String No /api/v1/channel

The request URL.

RegionId String No cn-hangzhou

The ID of the region.

Response parameters

Parameter Type Example Description
DynamicCode String ExplorerException

The error code.

DynamicMessage String An error in the monitoring service has occurred.

The error message.

ErrorCode Integer 200

The returned code.

RequestId String 19E91C1D-9BD0-468F-A7DA-915263C6689F

The ID of the API request.

Result String xxxx

The returned result.

Success Boolean true

The returned status.

Examples

Sample requests


# Get a list of valid API versions, which is supported from version v2
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api&<Common request parameters>


# Get all channel information
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api/v1/channel&<Common request parameters>


# Get the channel information of the channel named ":channel"
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api/v1/channel/:channel&<Common request parameters>


# Obtain the block information in the channel named ":channel". "${limit}" indicates the maximum number of blocks to be acquired, and ${offset} indicates the starting block to be acquired. ${offset} starting from 0, it can be a negative integer.
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api/v1/channel/:channel/block?limit=${limit}&offset=${offset}&<Common request parameters>


# Obtain the block information in the channel named ":channel". ":block" is blockId or blockHash
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api/v1/channel/:channel/block/:block&<Common request parameters>


# Get ":tx" information in the channel named ":channel"
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api/v1/channel/:channel/tx/:tx&<Common request parameters>


# Get metric information in the channel named ":channel"
# ":precision" can be minute or hour
# ":type" can be a type of block or tx
# "${left}" and "${right}" means the time interval for getting the metric, and the value needs to satisfy "new Date(${left | right})" in javascript
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api/v1/channel/:channel/metric/:precision/:type?left=${left}&right=${right}&<Common request parameters>


# Get the endorsement statistics of the channel named ":channel"
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api/v2/channel/:channel/statistics/endorser&<Common request parameters>


# Get the chaincode statistics of the channel named ":channel"
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api/v2/channel/:channel/statistics/chaincode&<Common request parameters>


# Get the validated transactions statistics of the channel named ":channel"
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api/v2/channel/:channel/statistics/result&<Common request parameters>


# Get the caller statistics of the channel named ":channel"
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api/v2/channel/:channel/statistics/creator&<Common request parameters>


# Get the endorser statistics of the chaincode named ":chaincode", in the channel named ":channel"
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api/v2/channel/:channel/statistics/chaincode/:chaincode/endorser&<Common request parameters>


# Get the validated transactions statistics of the chaincode named ":chaincode", in the channel named ":channel"
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api/v2/channel/:channel/statistics/chaincode/:chaincode/result&<Common request parameters>


# Get the caller statistics of the chaincode named ":chaincode", in the channel named ":channel"
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api/v2/channel/:channel/statistics/chaincode/:chaincode/creator&<Common request parameters>


# Get the called function statistics of the chaincode named ":chaincode", in the channel named ":channel"
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api/v2/channel/:channel/statistics/chaincode/:chaincode/function&<Common request parameters>


# Get the version statistics of the chaincode named ":chaincode", in the channel named ":channel"
http(s)://[Endpoint]/?Action=DescribeFabricExplorer&ExMethod=GET&ExUrl=/api/v2/channel/:channel/statistics/chaincode/:chaincode/version&<Common request parameters>

Successful response examples

XML format

<DescribeFabricExplorerResponse>
      <RequestId>AB2560A0-EF98-462D-B9BA-D422206B94B3</RequestId>
      <ErrorCode>200</ErrorCode>
      <Success>true</Success>
      <Result>xxx</Result>
</DescribeFabricExplorerResponse>

JSON format

{
	"Result":"xxx",
	"RequestId":"AB2560A0-EF98-462D-B9BA-D422206B94B3",
	"Success":true,
	"ErrorCode":200
}

Error codes

For more information about error codes, visit API Error Center.