1. 接口描述
接口请求域名: tbaas.tencentcloudapi.com 。
获取区块链网络概要
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:GetClusterSummary。 |
Version | 是 | String | 公共参数,本接口取值:2018-04-16。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Module | 是 | String | 模块名称,固定字段:cluster_mng |
Operation | 是 | String | 操作名称,固定字段:cluster_summary |
ClusterId | 是 | String | 区块链网络ID,可在区块链网络详情或列表中获取 |
GroupId | 是 | Integer | 组织ID,固定字段:0 |
GroupName | 是 | String | 调用接口的组织名称,可以在组织管理列表中获取当前组织的名称 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalChannelCount | Integer | 网络通道总数量 |
MyChannelCount | Integer | 当前组织创建的通道数量 |
JoinChannelCount | Integer | 当前组织加入的通道数量 |
TotalPeerCount | Integer | 网络节点总数量 |
MyPeerCount | Integer | 当前组织创建的节点数量 |
OrderCount | Integer | 其他组织创建的节点数量 |
TotalGroupCount | Integer | 网络组织总数量 |
MyGroupCount | Integer | 当前组织创建的组织数量 |
TotalChaincodeCount | Integer | 网络智能合约总数量 |
RecentChaincodeCount | Integer | 最近7天发起的智能合约数量 |
MyChaincodeCount | Integer | 当前组织发起的智能合约数量 |
TotalCertCount | Integer | 当前组织的证书总数量 |
TlsCertCount | Integer | 颁发给当前组织的证书数量 |
PeerCertCount | Integer | 网络背书节点证书数量 |
ClientCertCount | Integer | 当前组织业务证书数量 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 GetClusterSummary
输入示例
https://tbaas.tencentcloudapi.com/?Action=GetClusterSummary
&Module=cluster_mng
&Operation=cluster_summary
&ClusterId=251005746bc0f03q8u93j
&GroupId=0
&GroupName=liulanOrg
&<公共请求参数>
输出示例
{
"Response": {
"ClientCertCount": 2,
"JoinChannelCount": 1,
"MyChaincodeCount": 1,
"MyChannelCount": 1,
"MyGroupCount": 1,
"MyPeerCount": 2,
"PeerCertCount": 2,
"RecentChaincodeCount": 1,
"RequestId": "8646a1d8-bae3-4b41-8732-06b8c004eaa5",
"TlsCertCount": 4,
"TotalCertCount": 8,
"TotalChaincodeCount": 1,
"TotalChannelCount": 1,
"TotalGroupCount": 1,
"TotalPeerCount": 2
}
}
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.GroupIllegal | 用户非法操作。 |
FailedOperation.NoObject | 对象不存在。 |
FailedOperation.TimeOutUrl | 后台服务请求超时。 |
InternalError.FlaskException | Flask内部错误。 |
InternalError.NoDefineError | 错误码未定义。 |
InternalError.ServerException | 服务器异常。 |
InvalidParameterValue.IllegalFormat | 参数格式不正确。 |
InvalidParameterValue.IllegalValue | 请求参数错误。 |
InvalidParameterValue.ParameterEmpty | 参数值为空。 |