区块链服务 BCS区块链服务 BCS

更新时间:2021/08/24 GMT+08:00
分享

查询实例信息

功能介绍

查询指定服务实例详细信息

调试

您可以在API Explorer中调试该接口。

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

projectID

blockchain_id

String

blockchainID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

从IAM服务获取的用户Token

最小长度:1

最大长度:32768

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

basic_info

BasicInfo object

服务实例基本信息

channels

Array of ChannelInfo objects

通道信息

peer_info

Array of PeerInfo objects

peer组织信息

light_peer_info

Array of PeerInfo objects

light_peer组织信息

orderer_info

PeerInfo object

order组织信息

couch_db_info

CouchDBInfo object

couch db信息

dms_kafka_info

DmsKafkaInfo object

kafka实例创建状态

ief_info

IefInfo object

边缘集群信息

sfs_info

SfsInfo object

文件存储信息

agent_info

PeerInfo object

agent组织信息

restapi_info

PeerInfo object

restapi组织信息

evs_pvc_info

EvsPvcInfo object

evs_pvc信息

tc3_taskserver_info

PeerInfo object

tc3_taskserver组织信息

obs_bucket_info

OBSInfo object

OBS桶信息

表4 BasicInfo

参数

参数类型

描述

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),raft共识算法(etcdraft)

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集群(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)

表5 ChannelInfo

参数

参数类型

描述

name

String

通道名

org_names

Array of strings

通道中组织名

org_name_hash

Array of strings

通道中组织名的哈希值

peers

Map<String,Array<String>>

key:组织名,value:peer节点数组

表6 PeerInfo

参数

参数类型

描述

name

String

组织名称

node_cnt

Integer

节点数量

status

String

节点状态,分为创建中(IsCreating),升级中(IsUpgrading),扩缩容中(Adding/IsScaling),删除中(Isdeleting),正常(Normal),异常(AbNormal),未知(其余值)

status_detail

String

节点状态,形式如:1/1,分母是该组织下节点总数,分子是正常节点个数

pvc_name

String

节点对应pvc名称

address

Array of PeerAddress objects

Peer节点域名/IP地址

表7 CouchDBInfo

参数

参数类型

描述

user

String

couchDB用户名称

表8 DmsKafkaInfo

参数

参数类型

描述

addr

Array of strings

Kafka连接地址

order_fade_enable

Boolean

Kafka模式下,是否开启共识节点老化

order_fade_cache

Integer

Kafka模式下,开启共识节点后的老化阈值

表9 IefInfo

参数

参数类型

描述

deploy_mode

Integer

BCS服务边缘节点部署模式,分为:随机模式(0),绑定模式(1)

表10 SfsInfo

参数

参数类型

描述

pvc_name

String

BCS服务下的SFS文件系统名称

name

String

BCS服务网络存储名称

addr

String

BCS服务网络存储地址

type

String

BCS服务网络存储类型

表11 EvsPvcInfo

参数

参数类型

描述

{自定义key}

Map<String,PVCInfo>

云硬盘存储卷信息

表12 PVCInfo

参数

参数类型

描述

{自定义key}

Map<String,String>

key:容器实例名称,value:PVC名称

表13 PeerAddress

参数

参数类型

描述

domain_port

String

域名地址

ip_port

String

IP地址

表14 OBSInfo

参数

参数类型

描述

name

String

OBS桶名称

addr

String

OBS桶地址

状态码: 400

表15 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

状态码: 401

表16 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

状态码: 403

表17 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最小长度:8

最大长度:36

error_msg

String

错误描述

最小长度:2

最大长度:512

请求示例

响应示例

状态码: 200

Ok

{
  "basic_info" : {
    "id" : "50ca216f-f0e5-ea05-5aee-de8d8f0fb6fa",
    "name" : "bcs-vqf1x5",
    "version" : "3.0.7",
    "service_type" : "union",
    "purchase_type" : "",
    "sign_algorithm" : "ECDSA",
    "consensus" : "sflic",
    "charging_mode" : 1,
    "version_type" : 3,
    "database_type" : "goleveldb",
    "cluster_id" : "aaace2ac-c18b-11ea-aefb-0255ac100022",
    "cluster_name" : "roma-cluster",
    "cluster_type" : "",
    "cluster_platform_type" : "",
    "cluster_az" : "",
    "created_time" : "2020-07-22T04:03:44Z",
    "volume_type" : "",
    "deploy_type" : "",
    "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" : [ "24.68.213.148:30603" ],
    "status" : "Normal",
    "process_status" : "",
    "order_status" : 0,
    "enterprise_project_id" : "0",
    "enterprise_project_name" : "default",
    "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
  },
  "channels" : [ {
    "name" : "channel",
    "org_names" : [ "organization" ],
    "org_name_hash" : [ "organization:8ba7c7c2e84e57d1f16bd4739245e78aa2b08d3d" ],
    "peers" : {
      "8ba7c7c2e84e57d1f16bd4739245e78aa2b08d3d" : [ "peer-8ba7c7c2e84e57d1f16bd4739245e78aa2b08d3d-0.peer-8ba7c7c2e84e57d1f16bd4739245e78aa2b08d3d.default.svc.cluster.local", "peer-8ba7c7c2e84e57d1f16bd4739245e78aa2b08d3d-1.peer-8ba7c7c2e84e57d1f16bd4739245e78aa2b08d3d.default.svc.cluster.local" ]
    }
  } ],
  "peer_info" : [ {
    "name" : "organization",
    "node_cnt" : 2,
    "status" : "Normal",
    "status_detail" : "2/2",
    "pvc_name" : "",
    "rds_name" : ""
  } ],
  "light_peer_info" : [ ],
  "orderer_info" : {
    "name" : "bcs-vqf1x5-orderer",
    "node_cnt" : 4,
    "status" : "Normal",
    "status_detail" : "4/4",
    "address" : [ {
      "domain_port" : "orderer-7d5c1e483233482cfe8c8b003e003da45f07d545-0.orderer-7d5c1e483233482cfe8c8b003e003da45f07d545.default.svc.cluster.local:7050",
      "ip_port" : "24.68.213.148:30835"
    }, {
      "domain_port" : "orderer-7d5c1e483233482cfe8c8b003e003da45f07d545-1.orderer-7d5c1e483233482cfe8c8b003e003da45f07d545.default.svc.cluster.local:7050",
      "ip_port" : "24.68.213.148:30836"
    }, {
      "domain_port" : "orderer-7d5c1e483233482cfe8c8b003e003da45f07d545-2.orderer-7d5c1e483233482cfe8c8b003e003da45f07d545.default.svc.cluster.local:7050",
      "ip_port" : "24.68.213.148:30837"
    }, {
      "domain_port" : "orderer-7d5c1e483233482cfe8c8b003e003da45f07d545-3.orderer-7d5c1e483233482cfe8c8b003e003da45f07d545.default.svc.cluster.local:7050",
      "ip_port" : "24.68.213.148:30838"
    } ],
    "pvc_name" : "",
    "rds_name" : ""
  },
  "couch_db_info" : {
    "user" : ""
  },
  "dms_kafka_info" : {
    "order_fade_enable" : false,
    "order_fade_cache" : 0,
    "name" : "",
    "node_cnt" : 0,
    "status" : "",
    "status_detail" : ""
  },
  "ief_info" : {
    "deploy_mode" : 0
  },
  "sfs_info" : {
    "pvc_name" : "",
    "name" : "",
    "addr" : "",
    "type" : "host"
  },
  "agent_info" : {
    "org_name" : "baas-agent",
    "node_cnt" : 0,
    "status" : "Normal",
    "status_detail" : "1/1",
    "pvc_name" : "",
    "rds_name" : ""
  },
  "restapi_info" : {
    "name" : "",
    "node_cnt" : 0,
    "status" : "",
    "status_detail" : "",
    "pvc_name" : "",
    "rds_name" : ""
  },
  "tc3_taskserver_info" : {
    "name" : "",
    "node_cnt" : 0,
    "status" : "",
    "status_detail" : "",
    "pvc_name" : "",
    "rds_name" : ""
  },
  "obs_bucket_info" : {
    "name" : "",
    "addr" : ""
  }
}

状态码: 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"
}

状态码

状态码

描述

200

Ok

400

Bad Request

401

Unauthorized

403

Forbidden

错误码

请参见错误码

分享:

    相关文档

    相关产品