区块链服务 BCS-创建服务实例:请求参数

时间：2024-07-03 14:20:51

区块链服务 BCS

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	从 IAM 服务获取的用户Token 最小长度：1 最大长度：32768

表3 请求Body参数
参数	是否必选	参数类型	描述
name	是	String	区块链服务名称，支持英文，数字，中文字符和中划线(-)，不能以中划线(-)开头，长度4-24个字符。
version_type	是	Long	BCS 服务版本类型，可选：基础版（4），专业版（2），企业版（3）。被邀请方创建时，和邀请方保持一致。
fabric_version	否	String	Fabric版本，当前邀请方以及私有链的创建仅可选：2.2 ;被邀请方创建时，和邀请方保持一致，1.4版本服务仅支持1.15及以下版本集群. 默认值为2.2.
blockchain_type	否	String	区块链类型，默认私有链，可选：联盟链（union），私有链（private）。被邀请方创建时，和邀请方保持一致。
consensus	否	String	B CS 服务的共识策略，Fabric1.4版本可选：测试策略（solo）、快速拜占庭容错算法（SFLIC）；Fabric2.2版本可选：raft共识算法（etcdraft）、快速拜占庭容错算法（SFLIC）。被邀请方创建时，和邀请方保持一致。
sign_algorithm	否	String	BCS服务安全机制，可选：ECDSA（ECDSA），国密算法（sm2）
enterprise_project_id	是	String	BCS服务所属企业项目ID
volume_type	否	String	CCE集群存储卷类型，根据实际环境可选：云硬盘存储卷（evs），文件存储卷（nfs）, 极速文件存储卷（efs）
evs_disk_type	否	String	云硬盘存储卷类型，volume_type选择evs时必填，可选：普通I/O（SATA），高I/O（SAS），超高I/O（SSD）
org_disk_size	否	Long	节点组织存储容量，基础版和专业版至少100GB，企业版至少500GB
database_type	否	String	BCS服务数据库类型，包括文件数据库（goleveldb），NoSQL（couchdb），选择couchdb需要填写couchdb_info字段中的信息
resource_password	是	String	BCS服务资源、区块链管理密码
orderer_node_number	否	Long	共识组织节点数，被邀请方创实例时可不填。购买fabric2.2服务时必填，若共识策略为Raft（CFT），节点数为3；若共识策略为快速拜占庭容错共识算法（FBFT），节点数为4。
use_eip	否	Boolean	是否使用集群节点弹性IP
bandwidth_size	否	Long	弹性IP带宽
cluster_type	是	String	集群类型，可选：CCE集群。
create_new_cluster	是	Boolean	是否创建新集群，使用已有集群需要填写cce_cluster_info字段中的信息，创建新集群需要填写cce_create_info字段中的信息
cce_cluster_info	否	CCEClusterInfo object	使用已有CCE集群信息，说明：Fabric1.4版本服务仅支持1.15及以下版本集群
cce_create_info	否	CCECreateInfo object	创建新集群信息
ief_deploy_mode	否	Long	IEF集群部署方式，随机部署（0），组织节点绑定（1）。组织节点绑定模式时，peer_orgs 参数必填。组织名和IEF节点名必须一致。
ief_nodes_info	否	Array of IEFNode objects	IEF集群节点列表，使用边缘集群模式部署时必填。
peer_orgs	否	Array of OrgPeer objects	节点组织列表。节点绑定模式中，组织名和IEF节点名必须一致。边缘集群模式时此字段必填。
channels	否	Array of ChannelInfoV2 objects	通道列表
couchdb_info	否	CouchDb object	couchDB信息
turbo_info	否	TurboInfo object	极速文件存储卷信息
block_info	否	block_info object	区块生成配置信息
kafka_create_info	否	KafkaCreateInfo object	kafka实例创建信息
tc3_need	否	Boolean	是否添加可信计算平台
restful_api_support	否	Boolean	是否添加restful API支持
is_invitee	否	Boolean	是否是创建被邀请方BCS服务实例，创建被邀请方实例需要同时填写invitor_infos字段中的信息
invitor_infos	否	InvitorInfos object	邀请方信息

表4 CCEClusterInfo
参数	是否必选	参数类型	描述
cluster_id	是	String	集群ID
cluster_name	是	String	集群名称
cluster_platform_type	是	String	集群CPU架构类型：X86（VirtualMachine），ARM（ARM64）

表5 CCECreateInfo
参数	是否必选	参数类型	描述
node_num	是	Long	集群节点数
node_flavor	是	String	集群节点规格ID（支持的规格配置最小为4u8g）
cce_flavor	是	String	CCE集群规格
init_node_pwd	是	String	节点初始密码
az	是	String	可用区
cluster_platform_type	是	String	集群CPU架构类型：X86（VirtualMachine），ARM（ARM64）

表6 IEFNode
参数	是否必选	参数类型	描述
id	是	String	节点ID（注意：应填写IEF节点的ID信息）
status	是	String	节点状态:"ACTIVE"
public_ip_address	是	String	节点公有IP（弹性IP）

表7 OrgPeer
参数	是否必选	参数类型	描述
name	是	String	组织名称
node_count	是	Long	组织节点数

表8 ChannelInfoV2
参数	是否必选	参数类型	描述
name	是	String	通道名
org_names	是	Array of strings	通道中组织名
description	否	String	通道描述

表9 CouchDb
参数	是否必选	参数类型	描述
user_name	是	String	couchDB用户名
password	是	String	couchDB密码

**表10** TurboInfo
参数	是否必选	参数类型	描述
share_type	是	String	共享方式，固定值为“STANDARD”
type	是	String	类型，固定值为“efs-ha”
available_zone	是	String	可用区，可填空字符串("")。
resource_spec_code	是	String	规格，固定值为“sfs.turbo.standard”

**表11** block_info
参数	是否必选	参数类型	描述
batch_timeout	否	Long	区块产生时间（单位：秒），默认2秒
max_message_count	否	Long	区块包含交易数量，默认500
preferred_maxbytes	否	Long	区块容量（单位：MB），默认2MB

**表12** KafkaCreateInfo
参数	是否必选	参数类型	描述
spec	是	String	kafka实例规格，可选：mini：基准带宽100MB/s，small：基准带宽300MB/s，middle：基准带宽600MB/s，high：基准带宽1200MB/s
storage	是	Long	存储空间(单位：GB），至多9000，mini版至少300，small至少1200，middle至少2400，high至少4800
az	是	String	kafka实例可用区