tencent cloud

DescribeFabricBlock
Last updated: 2025-10-30 21:56:55
DescribeFabricBlock
Last updated: 2025-10-30 21:56:55

1. API Description

Domain name for API request: tbaas.intl.tencentcloudapi.com.

This API is used to retrieve the detailed information of a block in Fabric.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: DescribeFabricBlock.
Version Yes String Common Params. The value used for this API: 2018-04-16.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ClusterId Yes String Cluster ID, which can be obtained from the blockchain cluster details or in the list.
ChannelId Yes String Channel ID, which can be obtained from the channel list or channel detail.
BlockHeight Yes Integer Block height, starting from 0.

3. Output Parameters

Parameter Name Type Description
BlockHeight Integer Block height.
BlockHash String Block Hash.
PreBlockHash String Pre-Block Hash.
TxCount Integer The number of transactions in a block.
TransactionList Array of Transaction Transaction list in the block.
CreateTimestamp String Creation Timestamp
ProposerOrg String Proposal organization.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 DescribeFabricBlock

DescribeFabricBlock

Input Example

POST / HTTP/1.1
Host: tbaas.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeFabricBlock
<Common request parameters>

{
    "ClusterId": "fabric-65z42qi150",
    "ChannelId": "channel-9xej4d",
    "BlockHeight": 4
}

Output Example

{
    "Response": {
        "BlockHash": "e0421ecc20340425a2cf01808469b2523651f8100da92a0287b3769115e57370",
        "BlockHeight": 4,
        "CreateTimestamp": "2023-08-05 07:44:04",
        "PreBlockHash": "f69b2b5a1884e5bbb077a3025378e2210b83bbada23b5c17045b0bf537a53bd0",
ProposerOrg: Blockchain test organization pettychen
        "RequestId": "a6288649-01c0-4d8f-bdd4-ba02163d0721",
        "TransactionList": [
            {
                "BlockHeight": 4,
                "ChaincodeName": "_lifecycle",
                "CreateTime": "2023-08-05 15:44:04",
Sender: Blockchain test organization
                "TxId": "03389f4a5af1883347ecdb15471e70abf3a8e6cf5b6648dc789674af7930e229"
            }
        ],
        "TxCount": 1
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
FailedOperation.FabricBlockNoExist The block does not exist.
FailedOperation.InvalidAuth User has no access permission.
InternalError.ServerError Internal error. please try again later or contact technical personnel.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback