1. 接口描述
接口请求域名： tbaas.tencentcloudapi.com 。
获取通道列表
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：GetChannelListForUser。 |
| Version | 是 | String | 公共参数，本接口取值：2018-04-16。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Module | 是 | String | 模块名，本接口取值：channel_mng |
| Operation | 是 | String | 操作名，本接口取值：channel_list_for_user |
| ClusterId | 是 | String | 区块链网络ID，可在区块链网络详情或列表中获取 |
| GroupName | 是 | String | 组织名称 |
| Limit | 否 | Integer | 返回数据项数，本接口默认取值：10，上限取值：20 |
| Offset | 否 | Integer | 返回数据起始偏移，本接口默认取值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 通道总数量 |
| ChannelList | Array of ChannelDetailForUser | 通道列表 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 GetChannelListForUser
输入示例
POST / HTTP/1.1
Host: tbaas.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetChannelListForUser
<公共请求参数>
{
"Module": "channel_mng",
"Operation": "channel_list_for_user",
"ClusterId": "251005746envnew",
"GroupName": "hellorog",
"Limit": 10,
"Offset": 0
}输出示例
{
"Response": {
"TotalCount": 1,
"ChannelList": [
{
"ChannelName": "tongdaogz",
"PeerList": [
{
"PeerName": "peer0-qtagzorg.bcku93u4ke0g"
}
]
}
],
"RequestId": "32439457-7b4b-4b33-94e6-b3dc29a75d31"
}
}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
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.UnauthorizedOperation | 用户无权限访问。 |
| FailedOperation.ChainCodeChannel | 合约已在通道实例化。 |
| FailedOperation.ChainCodeExist | 合约已存在。 |
| FailedOperation.ChainCodeInit | 合约实例化错误。 |
| FailedOperation.ChainCodeInstall | 合约安装错误。 |
| FailedOperation.FabricManage | 区块链网络请求异常。 |
| FailedOperation.InvalidChaincode | 无效合约。 |
| FailedOperation.InvalidChannel | 无效通道。 |
| FailedOperation.InvalidCluster | 无效网络。 |
| FailedOperation.InvalidGroup | 无效组织。 |
| FailedOperation.InvalidPeer | 无效节点。 |
| FailedOperation.InvalidResource | 无效资源。 |
| FailedOperation.NoChainCodeChannel | 合约没有在通道初始化。 |
| FailedOperation.NoChainCodePeer | 合约没有在节点安装。 |
| FailedOperation.NoChannelGroup | 组织没有加入通道。 |
| FailedOperation.NoChannelPeer | 节点没有加入通道。 |
| InternalError.FailPreform | 内部错误。 |
| InternalError.ServiceError | 服务异常，请重试。 |
| InternalError.UnknownError | 交易服务未知错误，请重试。 |
| InvalidParameterValue.IllegalValue | 参数取值不合法。 |