查看联盟链信息
功能介绍
查看联盟链信息
URI
GET /api/v1/consortiums/{consortiumId}
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
consortiumId |
是 |
String |
BCS服务id |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
appchainInfo |
BasicInfo object |
服务实例基本信息 |
consortiumName |
String |
服务实例名 |
consortiumMembers |
Array of OrgInfo objects |
成员信息 |
cipherSuit |
String |
加密算法 |
consensusNodeCount |
String |
共识节点数 |
consensusAlgorithm |
String |
共识算法 |
resourceId |
String |
集群id |
consensusStatus |
String |
状态 |
nodeCount |
String |
节点数 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
String |
BCS服务id |
name |
String |
BCS服务名 |
version |
String |
BCS服务版本信息 |
service_type |
String |
BCS服务的类型,分为:联盟链(union),私有链(private) |
purchase_type |
String |
BCS服务部署类型,分为:一键部署(onestep),普通部署(normal) |
sign_algorithm |
String |
BCS服务安全机制,分为:ECDSA(ECDSA),国密算法(sm2) |
consensus |
String |
BCS服务的共识策略,分为:测试策略(solo),快速拜占庭容错算法(sflic),Kafka(kafka) |
charging_mode |
Integer |
BCS服务付费模式,分为:按需(1),包周期(0) |
version_type |
Integer |
BCS服务版本类型 |
database_type |
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) |
created_time |
String |
BCS服务创建时间 |
deploy_type |
String |
BCS服务联盟链下生效,分为邀请方(create),被邀请方(invite) |
is_cross_region |
Boolean |
BCS服务是否跨region |
is_support_rollback |
Boolean |
BCS服务升级失败,是否支持回滚 |
is_support_restful |
Boolean |
BCS服务是否添加RESTful APIs支持,分为支持(true),不支持(false) |
is_old_service |
Boolean |
区分BCS是否新服务,分为老服务(true),新服务(false) |
old_service_version |
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) |
参数 |
参数类型 |
描述 |
---|---|---|
status |
String |
组织状态 |
status_detail |
String |
组织状态详情 |
name |
String |
组织名 |
node_cnt |
Integer |
节点数量 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_message |
String |
错误描述 |
请求示例
无
响应示例
状态码: 200
服务实例详细信息
{ "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_info" : { "resource_error_code" : "", "order_id" : "", "order_type" : 0, "order_status" : 0, "delete" : 0, "operate" : 0, "release" : 0, "resource_status" : 0 }, "block_info" : { "batch_timeout" : 2, "max_message_count" : 500, "preferred_maxbytes" : 2 }, "is_support_tc3" : false, "tc3_taskserver_portal_addrs" : [ "192.168.0.217:32622" ] }, "resourceId" : "2a42be07-92e3-11eb-a172-0255ac100127", "consortiumMembers" : [ { "name" : "org1", "node_cnt" : 2, "status" : "Normal", "status_detail" : "2/2" }, { "name" : "neworg2", "node_cnt" : 1, "status" : "Normal", "status_detail" : "1/1" } ], "consensusStatus" : "Normal", "nodeCount" : "3" } }
状态码: 400
Bad Request
{ "error_code" : "BCS.4006005", "error_msg" : "keyType error, keyType: blok not supported" }
状态码
状态码 |
描述 |
---|---|
200 |
服务实例详细信息 |
400 |
Bad Request |
错误码
请参见错误码。
