更新时间:2024-07-03 GMT+08:00
分享

查询通道信息

功能介绍

查询指定服务实例通道信息

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v2/{project_id}/blockchains/{blockchain_id}/channels

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户从IAM申请到的项目ID,一般为32位字符串

blockchain_id

String

blockchainID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

从IAM服务获取的用户Token

最小长度:1

最大长度:32768

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

channels

Array of Channel objects

通道信息列表

表4 Channel

参数

参数类型

描述

name

String

通道名

description

String

通道细节描述

create_time

String

通道创建时间

consensus

String

共识策略

peers

Map<String,Array<String>>

key:组织名,value:节点名称列表

consensusNodes

Map<String,Array<String>>

key:组织名,value:节点名称列表

状态码: 400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

状态码: 401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

状态码: 403

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

状态码: 404

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

状态码: 500

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

请求示例

响应示例

状态码: 200

Ok

{
  "channels" : [ {
    "name" : "channel",
    "peers" : {
      "organization" : [ "peer-328000cb35d8971e0b0388f6182f95eaa4100784-0", "peer-328000cb35d8971e0b0388f6182f95eaa4100784-1" ]
    },
    "consensusNodes" : {
      "organization" : [ "peer-328000cb35d8971e0b0388f6182f95eaa4100784-0" ]
    },
    "consensus" : "etcdraft",
    "description" : "",
    "create_time" : "2020-10-15T10:24:51Z"
  } ]
}

状态码: 400

Bad Request

{
  "error_code" : "BCS.4006005",
  "error_msg" : "keyType error, keyType: blok not supported"
}

状态码: 401

Unauthorized

{
  "error_code" : "BCS.4010401",
  "error_msg" : "Incorrect token or token resolution failed"
}

状态码: 403

Forbidden

{
  "error_code" : "BCS.4030403",
  "error_msg" : "No permissions to request this method"
}

状态码: 404

Not Found

{
  "error_code" : "BCS.4040404",
  "error_msg" : "Not Found:the url is not found"
}

状态码: 500

InternalServerError

{
  "error_code" : "BCS.5000500",
  "error_msg" : "Internal Server Error"
}

状态码

状态码

描述

200

Ok

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

InternalServerError

错误码

请参见错误码

相关文档