1. 接口描述
接口请求域名： tbaas.tencentcloudapi.com 。
查看当前网络下的所有区块列表，分页展示
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：GetBlockList。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-16。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Module | 是 | String | 模块名称，固定字段：block |
| Operation | 是 | String | 操作名称，固定字段：block_list |
| ChannelId | 是 | Integer | 通道ID，固定字段：0 |
| GroupId | 是 | Integer | 组织ID，固定字段：0 |
| ChannelName | 是 | String | 需要查询的通道名称，可在通道详情或列表中获取 |
| GroupName | 是 | String | 调用接口的组织名称，可以在组织管理列表中获取当前组织的名称 |
| ClusterId | 是 | String | 区块链网络ID，可在区块链网络详情或列表中获取 |
| Offset | 否 | Integer | 需要获取的起始交易偏移 |
| Limit | 否 | Integer | 需要获取的交易数量 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 区块数量 |
| BlockList | Array of Block | 区块列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询所有区块列表
输入示例
https://tbaas.tencentcloudapi.com/?Action=GetBlockList
&Module=block
&Operation=block_list
&ChannelId=0
&GroupId=0
&ChannelName=kylotst
&GroupName=liulanOrg
&ClusterId=251005746bc0f03q8u93j
&Offset=0
&Limit=10
&<公共请求参数>输出示例
{
"Response": {
"BlockList": [
{
"BlockId": 5,
"BlockNum": 5,
"DataHash": "92f1c3b1eb0eb1bc1825f1acd3474e7679b2a97cdf8d6155ed6a0e6c1458e479",
"PreHash": "92f1c3b1eb0eb1bc1825f1acd3474e7679b2a97cdf8d6155ed6a0e6c1458e479",
"TxCount": 1
},
{
"BlockId": 4,
"BlockNum": 4,
"DataHash": "17e381e65605963c9211abc5b72d80cf3a6a4955ff7b61c70b406b98c90ded6f",
"PreHash": "17e381e65605963c9211abc5b72d80cf3a6a4955ff7b61c70b406b98c90ded6f",
"TxCount": 1
},
{
"BlockId": 3,
"BlockNum": 3,
"DataHash": "32b80e93141467eda367f05a2428a6c03369405ae10349db7fad0762e9b56cc2",
"PreHash": "32b80e93141467eda367f05a2428a6c03369405ae10349db7fad0762e9b56cc2",
"TxCount": 1
},
{
"BlockId": 2,
"BlockNum": 2,
"DataHash": "8be5094bf40c5b7e410cc3e8aa33354da2aa78db862e17cfd5fa783dddc1ee3a",
"PreHash": "8be5094bf40c5b7e410cc3e8aa33354da2aa78db862e17cfd5fa783dddc1ee3a",
"TxCount": 1
},
{
"BlockId": 1,
"BlockNum": 1,
"DataHash": "af319fe2ff9e5830af0f07200adf965156446a205137e61d87f1db0b8f43cc7e",
"PreHash": "af319fe2ff9e5830af0f07200adf965156446a205137e61d87f1db0b8f43cc7e",
"TxCount": 1
},
{
"BlockId": 0,
"BlockNum": 0,
"DataHash": "96f22d00947478c1b16c2aec5e7079c761b168d304cadf19a14a032ee8f64a23",
"PreHash": "96f22d00947478c1b16c2aec5e7079c761b168d304cadf19a14a032ee8f64a23",
"TxCount": 1
}
],
"RequestId": "018328c8-9c24-4104-a0ad-a7a31c033278",
"TotalCount": 6
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.UnauthorizedOperation | 用户无权限访问。 |
| FailedOperation.FabricBlockQuery | 区块列表查询失败。 |
| FailedOperation.FabricRequstParams | 参数验证失败。 |
| FailedOperation.GroupIllegal | 用户非法操作。 |
| FailedOperation.NoChannelPeer | 节点没有加入通道。 |
| FailedOperation.NoObject | 对象不存在。 |
| FailedOperation.TimeOutUrl | 后台服务请求超时。 |
| InternalError.FlaskException | Flask内部错误。 |
| InternalError.NoDefineError | 错误码未定义。 |
| InternalError.ServerException | 服务器异常。 |
| InvalidParameterValue.IllegalFormat | 参数格式不正确。 |
| InvalidParameterValue.IllegalValue | 请求参数错误。 |
| InvalidParameterValue.ParameterEmpty | 参数值为空。 |
