查看联盟链信息

功能介绍

查看联盟链信息

URI

GET /api/v1/consortiums/{consortiumId}

表5-62 路径参数

参数 是否必选 参数类型 描述

consortiumId 是 String BCS服务id

请求参数

无

响应参数

状态码： 200

表5-63 响应 Body 参数

参数 参数类型 描述

appchainInfo BasicInfo

object 服务实例基本信息 consortiumNa

me String 服务实例名

consortiumM

embers Array of OrgInfo objects

成员信息

开发指南 5 区块链中间件接口

参数 参数类型 描述 cipherSuit String 加密算法 consensusNod

eCount String 共识节点数 consensusAlg

orithm String 共识算法

resourceId String 集群id consensusStat

us String 状态

nodeCount String 节点数

表5-64 BasicInfo

参数 参数类型 描述

id String BCS服务id

name String BCS服务名

version String BCS服务版本信息

service_type String BCS服务的类型，分为：联盟链（union），私有 链（private）

purchase_type String BCS服务部署类型，分为：一键部署

（onestep），普通部署（normal）

sign_algorith

m String BCS服务安全机制，分为：ECDSA（ECDSA），

国密算法（sm2）

consensus String BCS服务的共识策略，分为：测试策略（solo），

快速拜占庭容错算法（sflic），Kafka（kafka）

charging_mod

e Integer BCS服务付费模式，分为：按需（1），包周期

（0）

version_type Integer BCS服务版本类型 database_typ

e String BCS服务数据库类型，包括文件数据库

（goleveldb），NoSQL（couchdb）

cluster_id String BCS服务所在集群id cluster_name String BCS服务所在集群名称

cluster_type String BCS服务的集群类型，分为：CCE集群（空），

IEF集群（ief）

cluster_az String BCS多可用区标示，分为：多可用区（yes），非 多可用区（no）

开发指南 5 区块链中间件接口

参数 参数类型 描述

created_time String BCS服务创建时间

deploy_type String BCS服务联盟链下生效，分为邀请方（create），

被邀请方（invite）

is_cross_regio

n Boolean BCS服务是否跨region is_support_rol

lback Boolean BCS服务升级失败，是否支持回滚 is_support_res

tful Boolean BCS服务是否添加RESTful APIs支持，分为支持

（true），不支持（false）

is_old_service Boolean 区分BCS是否新服务，分为老服务（true），新服 务（false）

old_service_ve

rsion String BCS服务为老服务时，此字段为老服务版本号 agent_portal_

addrs Array of

strings BCS服务用户数据面agent地址端口列表 status String BCS服务状态，分为正常（Normal），异常

（Abnormal），弹性IP异常（EipAbnormal），

已冻结（Freeze），休眠中（Hibernation），未 知（其余值）

process_status String BCS服务处理状态，分为创建中（IsCreating），

升级中（IsUpgrading），扩缩容中

（IsScaling），删除中（IsDeleting），添加中

（IsAdding）

表5-65 OrgInfo

参数 参数类型 描述

status String 组织状态

status_detail String 组织状态详情

name String 组织名

node_cnt Integer 节点数量

状态码： 400

开发指南 5 区块链中间件接口

表5-66 响应 Body 参数

参数 参数类型 描述

error_code String 错误码 error_messag

{ "consortiumInfo" : {

"consortiumVersion" : "4.0.3",

"consortiumName" : "ugbaas-nodelete", "cipherSuit" : "ECDSA",

"consensusNodeCount" : "3", "consensusAlgorithm" : "etcdraft", "appChainInfo" : {

"id" : "224d04de-d5f9-cb0a-21d9-05b91323b586", "name" : "ugbaas-nodelete",

"version" : "4.0.3", "service_type" : "union", "purchase_type" : "onestep", "sign_algorithm" : "ECDSA", "consensus" : "etcdraft", "charging_mode" : 1, "version_type" : 3,

"database_type" : "goleveldb",

"cluster_id" : "2a42be07-92e3-11eb-a172-0255ac100127", "cluster_name" : "test2",

"cluster_type" : "cce", "cluster_platform_type" : "", "cluster_az" : "",

"created_time" : "2021-04-02T03:25:03Z", "volume_type" : "",

"deploy_type" : "create", "order_fade_enabled" : false, "order_fade_cache" : 0, "is_cross_region" : false, "is_support_rollback" : false, "is_support_restful" : false, "is_old_service" : false, "old_service_version" : "",

"agent_portal_addrs" : [ "192.168.0.217:30603" ], "status" : "Normal",

"process_status" : "", "order_status" : 0,

"enterprise_project_id" : "0",

"enterprise_project_name" : "default",

"current_version" : [ "2.1.27", "3.0.11", "4.0.3" ], "deploy_status" : 0,

"order_status" : 0,

"tc3_taskserver_portal_addrs" : [ "192.168.0.217:32622" ] },

"resourceId" : "2a42be07-92e3-11eb-a172-0255ac100127", "consortiumMembers" : [ {

"consensusStatus" : "Normal", "nodeCount" : "3"

}}

状态码： 400 Bad Request

{ "error_code" : "BCS.4006005",

"error_msg" : "keyType error, keyType: blok not supported"

}

状态码

状态码 描述

200 服务实例详细信息

400 Bad Request

错误码

GET /api/v1/consortiums/{consortiumId}/nodes

开发指南 5 区块链中间件接口