华为云用户手册

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取 IAM 用户Token（使用密码）接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的ID，获取方法请参见获取项目ID。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取IAM用户Token（使用密码）。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "id": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求消息头 附加请求头字段，如指定的URI和HTTPS方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type：消息体的类型（格式），必选，默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 X-Auth-Token：用户Token，可选，当使用Token方式认证时，必须填充该字段。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参考AK/SK认证。 对于获取IAM用户Token（使用密码）接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 1 2 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

API概览 通过使用 区块链 服务所提供的管理接口，您可以通过调用API使用区块链服务的功能，包括 BCS 实例的创建、删除，构建联盟链等，接口说明如表1所示。 表1 API概览 类型 API 说明 B CS 管理 创建服务实例 创建BCS服务实例。 查询创建状态 查询指定服务实例创建状态。 查询实例信息 查询指定服务实例详细信息。 修改服务实例 修改实例的节点、组织，目前仅支持添加节点，添加组织。 创建通道 创建通道。 查询通道信息 查询指定服务实例通道信息。 peer节点加入通道 peer节点加入通道。 BCS组织退出某通道 用于BCS组织退出某通道。 下载证书 下载指定服务实例相关证书。 下载SDK配置 下载指定服务实例SDK配置文件。 生成用户证书 通过用户名生成指定服务实例组织用户证书。 解冻用户证书 解冻指定服务实例组织用户证书，解冻后需等待半分钟到一分钟左右生效。 冻结用户证书 冻结指定服务实例组织用户证书，冻结后需等待半分钟到一分钟左右生效。 查询配额 查询当前项目下BCS服务所有资源的配额信息。 查询规格 查询当前项目下所有服务实例的简要信息。 查询节点信息 查询指定服务实例节点信息。 查询异步操作结果 查询异步操作结果。 查询服务实例列表 查询当前项目下所有服务实例的简要信息。 删除bcs实例 删除BCS实例。 BCS某个组织中的节点退出某通道 BCS某个组织中的节点退出某通道。 BCS删除某个通道 BCS删除某个通道。 BCS联盟 邀请联盟成员 批量邀请联盟成员加入通道，此操作会向被邀请方发出邀请通知。 处理联盟邀请 处理联盟邀请。 获取全部通知 获取全部通知。 获取联盟成员列表 获取联盟成员列表。 删除邀请成员信息 批量取消邀请或删除对已退出或拒绝加入或解散的成员邀请信息。 被邀请方退出联盟 被邀请方退出联盟。 BCS监控 查询服务实例告警信息 用于查询BCS服务的监控数据，可以指定相应的指标名称。 查询服务实例告警统计接口 用于查询BCS服务的告警统计数据，可以指定相应的指标名称。 查询BCS服务实例监控数据 用于查询BCS服务的监控数据，可以指定相应的指标名称。 查询BCS组织监控数据列表 用于查询BCS组织的监控数据列表。 查询BCS组织实例监控数据详情 用于BCS组织实例监控数据详情。 父主题： Hyperledger Fabric增强版管理

基本概念 账号 用户注册账号时，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用该用户进行日常管理工作。 用户 由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域（Region） 从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 可用区（AZ，Availability Zone） 一个AZ是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中创建资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 图1 项目隔离模型 同样在我的凭证下，您可以查看项目ID。 父主题： 使用前必读

AK/SK认证 AK/SK签名认证方式仅支持消息体大小12M以内，12M以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK（Access Key ID）：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK（Secret Access Key）：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 1 2 3 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ....

响应消息体 响应消息体通常以结构化格式（如JSON或XML）返回，与响应消息头中Content-Type对应，传递除响应消息头之外的内容。 对于获取IAM用户Token（使用密码）接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 1 2 3 4 5 6 7 8 9 10 11 12 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "az-01", ...... 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_msg": "The format of message is error", "error_code": "AS.0001" } 其中，error_code表示错误码，error_msg表示错误描述信息。

响应示例 状态码： 200 Ok { "operation_id" : "B CSS VC01-06-1624275286218943067" } 状态码： 400 Bad Request { "error_code" : "BCS.4006014", "error_msg" : "Invalid Parameter quotasType : ecs" } 状态码： 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" }

URI PUT /v2/{project_id}/blockchains/{blockchain_id}/{channel_id}/orgs/quit 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户从IAM申请到的projectid，一般为32位字符串。 blockchain_id 是 String 区块链服务id。 channel_id 是 String 区块链通道名称。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 operation_id String 操作记录id 状态码： 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

请求示例 paas_bcs_c00218797_02邀请方channel通道邀请用户xxx { "bcs_id" : "ba0fc16d-c752-9ac4-7a43-7a84443e0a06", "channel_name" : "channel", "invitor_username" : "paas_bcs_c00218797_02", "invited_userinfo" : [ { "invited_user" : "xxx" } ] }

响应示例 状态码： 200 Ok { "result" : "success" } 状态码： 400 Bad Request { "error_code" : "BCS.4006014", "error_msg" : "Invalid Parameter quotasType : ecs" } 状态码： 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" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 账号token 最小长度：1 最大长度：32768 表3 请求Body参数 参数 是否必选 参数类型 描述 bcs_id 是 String 发出邀请的服务实例ID channel_name 是 String 邀请加入的通道名 invitor_username 否 String 发出邀请的租户名 invited_userinfo 是 Array of InvitedDomain objects 被邀请的用户列表 表4 InvitedDomain 参数 是否必选 参数类型 描述 invited_user 是 String 被邀请方租户

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 result String 请求成功的结果 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

响应示例 状态码： 200 Ok { "operation_id" : "BCSSVC01-03-1617158790255323683" } 状态码： 400 Bad Request { "error_code" : "BCS.4001249", "error_msg" : "the channel(%s) is not empty for the bcs(%s), so cannot delete channel, please remove orgs from this channel first" } 状态码： 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" }

URI DELETE /v2/{project_id}/blockchains/{blockchain_id}/channel/{channel_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户从IAM申请到的projectid，一般为32位字符串。 blockchain_id 是 String 区块链服务id。可调用“查询服务实例列表”接口获取ID channel_id 是 String 区块链通道名称。可调用“查询实例信息”接口获取，接口返回的“channels”中的name字段值

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 operation_id String 操作记录id 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 - File Ok 状态码： 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 { "result" : "success" } 状态码： 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" }

请求示例 下载sdk配置,包含组织organization { "chaincode_name" : "chaincode", "cert_path" : "/root", "channel_name" : "channel", "peer_orgs" : { "organization" : [ "peer-328000cb35d8971e0b0388f6182f95eaa4100784-0.peer-328000cb35d8971e0b0388f6182f95eaa4100784.default.svc.cluster.local", "peer-328000cb35d8971e0b0388f6182f95eaa4100784-1.peer-328000cb35d8971e0b0388f6182f95eaa4100784.default.svc.cluster.local" ] } }

购买一个组织 接口相关信息 URI格式： POST /v2/{project_id}/huaweicloudchain/instances/{instance_id}/organizations 请求示例 POST https://{bcs_endpoint}/v2/{project_id}/huaweicloudchain/instances/{instance_id}/organizations {bcs_endpoint}信息请从地区和终端节点获取，{project_id}信息请参考获取项目ID，{instance_id}信息请参考查询实例列表。 Body： { "orgs" : [ { "name" : "org1" }], "org_order_info" : { "charge_mode" : 0, "period_type" : 2, "period_num" : 1, "is_auto_pay" : true, "is_auto_renew" : true } } 响应示例 { "order_id" : "CS2205101612RBMZD", "order_num" : 1, "instance_id" : "e224e6b6-e215-11ec-9675-0255ac101552", "job_id" : "e9541c1a-e17e-11ec-9826-0255ac10040d" }

响应示例 状态码： 200 Ok { "operation_id" : "BCSSVC01-03-1617158790255323683" } 状态码： 400 Bad Request { "error_code" : "BCS.4006014", "error_msg" : "Invalid Parameter quotasType : ecs" } 状态码： 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 表5 响应Body参数 参数 参数类型 描述 operation_id String 操作记录id 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

响应参数 状态码： 200 表14 响应Body参数 参数 参数类型 描述 blockchain_id String 服务实例ID blockchain_name String 服务实例名 operation_id String 操作ID 状态码： 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 状态码： 404 表18 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512 状态码： 500 表19 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：8 最大长度：36 error_msg String 错误描述 最小长度：2 最大长度：512

响应示例 状态码： 200 Ok { "blockchain_id" : "12691561-a50d-5207-6041-7346c90d4499", "blockchain_name" : "bcs-api", "operation_id" : "BCSSVC01-03-1617158790255323683" } 状态码： 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" }

请求示例 创建BCS实例 { "name" : "bcs-test", "fabric_version" : "2.2", "blockchain_type" : "union", "consensus" : "etcdraft", "version_type" : 4, "sign_algorithm" : "ECDSA", "enterprise_project_id" : "0", "volume_type" : "nfs", "evs_disk_type" : "SATA", "org_disk_size" : 100, "database_type" : "goleveldb", "resource_password" : "xxx", "orderer_node_number" : 3, "use_eip" : true, "bandwidth_size" : 5, "cluster_type" : "cce", "create_new_cluster" : false, "cce_cluster_info" : { "cluster_id" : "5adc2ce2-9712-11ea-9535-0255ac100b0d", "cluster_name" : "byl-1-15", "cluster_platform_type" : "ARM64" }, "cce_create_info" : { "node_num" : 1, "node_flavor" : "Si1.xlarge.4.linux", "cce_flavor" : "cce.s1.small", "init_node_pwd" : "JDYkUzdOOUR0JEdyajFQV0tSWXNQRjZBZlhiSE5MVmpWV204V3M5alFMUXl4Z3dtOVNKb25xR0lIZWZaNUFReDVWeHNJa3gvb3JML2d1WjZyazNLQmNWczBpWVVFR2gw", "az" : "cn-north-7a", "cluster_platform_type" : "ARM64" }, "ief_deploy_mode" : 0, "ief_nodes_info" : [ { "status" : "ACTIVE", "public_ip_address" : "192.168.1.95", "id" : "5700372e-49ef-4f4c-b433-11d95ad7acea" }, { "status" : "ACTIVE", "public_ip_address" : "192.168.1.213", "id" : "2455e71a-d806-4827-9cf4-81e1b3764681" } ], "peer_orgs" : [ { "name" : "organization", "node_count" : 2 } ], "channels" : [ { "name" : "channel", "org_names" : [ "organization" ], "description" : "" } ], "block_info" : { "batch_timeout" : 2, "max_message_count" : 500, "preferred_maxbytes" : 2 }, "turbo_info" : { "share_type" : "STANDARD", "type" : "efs-ha", "available_zone" : "cn-north-7a", "resource_spec_code" : "sfs.turbo.standard" } }

请求参数 表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 BCS服务的共识策略，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实例可用区 表13 InvitorInfos 参数 是否必选 参数类型 描述 tenant_id 是 String 邀请方租户ID project_id 是 String 邀请方项目ID blockchain_id 是 String 邀请方BCS服务实例ID

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 operation_id String 操作记录id 状态码： 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 { "operation_id" : "BCSSVC01-03-1617158790255323683" } 状态码： 400 Bad Request { "error_code" : "BCS.4006014", "error_msg" : "Invalid Parameter is_delete_obs ,must be true or false" } 状态码： 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" }

URI DELETE /v2/{project_id}/blockchains/{blockchain_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户从IAM申请到的项目ID，一般为32位字符串 blockchain_id 是 String bcs 服务id 表2 Query参数 参数 是否必选 参数类型 描述 is_delete_storage 否 Boolean 是否删除存储，IEF模式下不用填写 is_delete_obs 否 Boolean 是否删除obs，IEF模式下不用填写 is_delete_resource 否 Boolean 是否删除底层CCE资源，IEF模式下不用填写 is_delete_ief 否 Boolean 是否删除底层依赖的IEF边缘节点资源，CCE模式下不用填写，IEF模式下必填 is_delete_lightpeer 否 String CCE模式下选填：是否删除LightPeer轻节点插件使用的IEF边缘节点资源，若需要删除，则填写对应的IEF编译节点名称，否则无需填写。例如：is_delete_lightpeer=ief_node_name_1,ief_node_name_2 ief_nodes_id 否 String IEF模式下选填：若需要删除IEF边缘集群所使用的IEF边缘节点资源，则填写IEF节点的id，否则无需填写。例如：ief_nodes_id=1356f6f0-c448-4ec2-926f-c13b026369d9，0cdacbf9-2002-41e9-8123-2fa13e8d1449