华为云用户手册

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度：3 最大长度：3 error_code String 错误码 最小长度：12 最大长度：12 error_msg String 错误信息 最小长度：1 最大长度：65535 message String 错误详细信息 最小长度：1 最大长度：65535 状态码： 401 表5 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度：3 最大长度：3 error_code String 错误码 最小长度：12 最大长度：12 error_msg String 错误信息 最小长度：1 最大长度：65535 message String 错误详细信息 最小长度：1 最大长度：65535 状态码： 500 表6 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度：3 最大长度：3 error_code String 错误码 最小长度：12 最大长度：12 error_msg String 错误信息 最小长度：1 最大长度：65535 message String 错误详细信息 最小长度：1 最大长度：65535

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 最小长度：1 最大长度：65535 表3 请求Body参数 参数 是否必选 参数类型 描述 cert_path 是 String 证书存放路径 download_ca 否 Boolean 是否下载组织ca私钥、证书 orgs 是 Array of strings 需要下载客户端配置、证书的组织ID列表 最小长度：4 最大长度：26 数组长度：1 - 100 access_mode 是 String 区块链 后台访问方式：标准通道（StandardChannel）、高性能通道（HighPerformanceChannel） 枚举值： StandardChannel HighPerformanceChannel endpoint_ip 否 String 终端节点IP，选择高性能通道时必填

请求示例 { "name" : "test01", "version" : "1.0", "type" : "solidity", "install_orgs" : "[\"org1-c0dx4mj1u\",\"org2-spogt1az5\"]", "endorse_orgs" : "[\"org1-c0dx4mj1u\",\"org2-spogt1az5\"]", "endorse_policy" : "OR", "byte_code" : "xxx" } { "name" : "test01", "version" : "1.0", "type" : "go", "install_orgs" : "[\"org1-c0dx4mj1u\",\"org2-spogt1az5\"]", "endorse_orgs" : "[\"org1-c0dx4mj1u\",\"org2-spogt1az5\"]", "endorse_policy" : "OR" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result String 操作结果，值固定为success 最小长度：7 最大长度：7 状态码： 400 表5 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度：3 最大长度：3 error_code String 错误码 最小长度：12 最大长度：12 error_msg String 错误信息 最小长度：1 最大长度：65535 message String 错误详细信息 最小长度：1 最大长度：65535 状态码： 401 表6 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度：3 最大长度：3 error_code String 错误码 最小长度：12 最大长度：12 error_msg String 错误信息 最小长度：1 最大长度：65535 message String 错误详细信息 最小长度：1 最大长度：65535 状态码： 500 表7 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度：3 最大长度：3 error_code String 错误码 最小长度：12 最大长度：12 error_msg String 错误信息 最小长度：1 最大长度：65535 message String 错误详细信息 最小长度：1 最大长度：65535

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 最小长度：1 最大长度：65535 表3 FormData参数 参数 是否必选 参数类型 描述 name 是 String 合约名称，支持小写字母和数字，必须以小写字母开头 最小长度：6 最大长度：25 version 是 String 合约版本号，支持小写字母、数字、点和下划线，必须以小写字母或数字开头，数字结尾，且不能包含连续两个点或者下划线，也不能包含点和下划线相邻 最小长度：2 最大长度：14 type 是 String 合约类型：Go语言类型（go）、Solidity语言类型(solidity)、Java语言类型(java) 枚举值： go solidity java install_orgs 是 String 合约安装的组织ID列表，合约类型为solidity时该字段可不填写 最小长度：10 最大长度：65535 endorse_orgs 是 String 合约背书的组织ID列表，合约类型为solidity时该字段可不填写 最小长度：10 最大长度：65535 endorse_policy 是 String 合约背书策略：任意组织背书（OR）、全部组织背书（AND），合约类型为soildity的时候背书策略只能为任意组织背书 枚举值： OR AND file 是 File 合约ZIP文件。当前只支持Go和java语言类型合约，只能上传一个zip文件。go语言类型合约，zip文件不能超过30M，子文件总数不能超过1000000个，子文件总大小不能超过500M。java语言类型合约，zip文件不能超过100M，子文件只能是以contract.jar为名称的jar包，jar包不能超过100M。 description 否 String 合约描述 最小长度：0 最大长度：50 security_check 否 String 是否开启合约安全检查任务；true表示开启，其它值表示不开启；当前只支持Go语言类型合约 枚举值： true byte_code 否 String Solidity合约字节码内容 最小长度：0 最大长度：512000

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 result String 操作结果，值固定为success 最小长度：7 最大长度：7 状态码： 400 表4 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度：3 最大长度：3 error_code String 错误码 最小长度：12 最大长度：12 error_msg String 错误信息 最小长度：1 最大长度：65535 message String 错误详细信息 最小长度：1 最大长度：65535 状态码： 401 表5 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度：3 最大长度：3 error_code String 错误码 最小长度：12 最大长度：12 error_msg String 错误信息 最小长度：1 最大长度：65535 message String 错误详细信息 最小长度：1 最大长度：65535 状态码： 403 表6 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度：3 最大长度：3 error_code String 错误码 最小长度：12 最大长度：12 error_msg String 错误信息 最小长度：1 最大长度：65535 message String 错误详细信息 最小长度：1 最大长度：65535 状态码： 500 表7 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度：3 最大长度：3 error_code String 错误码 最小长度：12 最大长度：12 error_msg String 错误信息 最小长度：1 最大长度：65535 message String 错误详细信息 最小长度：1 最大长度：65535

URI DELETE /v2/{project_id}/besu/instances/{instance_id}/chain/tokens/{token_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 最小长度：32 最大长度：32 instance_id 是 String 实例ID 最小长度：36 最大长度：36 token_id 是 String 实例ID 最小长度：36 最大长度：36

请求示例 创建 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" } }

响应参数 状态码： 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" : "B CSS VC01-03-1617158790255323683" } 状态码： 400 Bad Request { "error_code" : "B CS .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" }

请求参数 表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 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" }

响应参数 状态码： 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

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 chain_id String 链ID consensus String 区块链共识类型：raft sign_algorithm String 区块链签名算法：ECDSA（ecdsa_with_sha256）、国密（sm2_with_sm3） tps_limit Integer 链交易tps上限 consensus_org String 共识组织ID contract_num Integer 合约数量 最小值：0 最大值：100 block_num Integer 区块数量 transaction_num Integer 交易数量 orgs Array of ChainOrgInfo objects 链上所有组织信息 数组长度：1 - 200 表4 ChainOrgInfo 参数 参数类型 描述 id String 组织在链上的ID name String 组织名称 transaction_num Integer 组织发送交易数 is_consensus Boolean 是否为共识组织，共识组织为true，非共识组织为false is_local Boolean 是否为本地组织 is_exist Boolean 组织是否存在当前链上 member_id String 组织所属成员ID member_name String 组织所属成员名称 状态码： 400 表5 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度：3 最大长度：3 error_code String 错误码 最小长度：12 最大长度：12 error_msg String 错误信息 最小长度：1 最大长度：65535 message String 错误详细信息 最小长度：1 最大长度：65535 状态码： 401 表6 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度：3 最大长度：3 error_code String 错误码 最小长度：12 最大长度：12 error_msg String 错误信息 最小长度：1 最大长度：65535 message String 错误详细信息 最小长度：1 最大长度：65535 状态码： 500 表7 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度：3 最大长度：3 error_code String 错误码 最小长度：12 最大长度：12 error_msg String 错误信息 最小长度：1 最大长度：65535 message String 错误详细信息 最小长度：1 最大长度：65535

响应示例 状态码： 200 请求成功 { "chain_id" : "bcs-test-f1766f8bc", "consensus" : "raft", "sign_algorithm" : "ecdsa_with_sha256", "tps_limit" : 50000, "consensus_org" : "org1-ei3n393nf", "contract_num" : 3, "block_num" : 215555, "transaction_num" : 302256, "orgs" : [ { "id" : "org1-ei3n393nf", "name" : "org1", "is_consensus" : true, "is_local" : true, "is_exist" : true, "member_id" : "051ddda48580d3371fc6c014ba7175b5", "member_name" : "zhangsan", "transaction_num" : 302256 } ] }

响应示例 状态码： 200 请求成功 { "uid" : "f1766f8b-c55a-11ec-a67c-0255ac10040d", "name" : "org1", "chain_org_id" : "org1-f8587hwjt", "status" : "Available", "is_consensus" : true, "capacity_info" : { "total" : 512000, "used" : 102400 }, "subscription_id" : "01154-360000102-0", "order_info" : { "edition" : "Professional", "charge_mode" : 0, "period_type" : 2, "period_num" : 1, "is_auto_pay" : true, "is_auto_renew" : true }, "countdown" : { "countdown_code" : "hws_countdown_period_using", "countdown_infos" : { "status" : 2, "next_operation_policy" : 0, "next_operation_remaining_day" : 28 }, "countdown_tips" : { "eff_time" : "2022-04-26T12:37:16Z", "exp_time" : "2022-05-26T15:59:59Z" } }, "create_time" : "2022-04-16T07:20:05Z", "update_time" : "2022-04-16T07:20:05Z" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 uid String 组织资源ID name String 组织名称 chain_org_id String 组织在链上的ID status String 组织状态：正常（Available）、异常（Exception）、不可用（Unavailable）、待付款（Unpaid）、创建中（Creating）、删除中（Deleting） endpoint String besu链节点地址 is_consensus Boolean 是否为共识组织，共识组织为true，非共识组织为false capacity_info capacity_info object 组织磁盘容量相关信息 subscription_id String 资源对应的订购实例ID，可用于组织退订 order_info order_info object 组织订购相关信息 countdown countdown object 组织资源倒计时信息 create_time String 组织创建时间 update_time String 组织数据更新时间 表5 capacity_info 参数 参数类型 描述 total Integer 组织单节点磁盘总容量，单位为MB used Integer 组织单节点磁盘使用容量，单位为MB 表6 order_info 参数 参数类型 描述 edition String 版本类型: 专业版（Professional）、企业版（Enterprise）、铂金版（Platinum） charge_mode Integer 资源计费模式:包周期计费（0） period_type Integer 订购周期类型:按月（2）、按年（3） period_num Integer 订购周期数量，按年只允许购买一年，按月可以购买1-9个月，超过9个月等同于一年 is_auto_pay Boolean 是否自动付款，true支持自动付款，false不支持自动付款 is_auto_renew Boolean 是否自动续费，true支持自动续费，false不支持自动续费 promotion_id String 资源购买参与促销时的促销活动ID，未参与则为空值；一次促销活动可包含多个促销计划 discount_plan_id String 资源购买参与促销时的折扣计划ID 表7 countdown 参数 参数类型 描述 countdown_code String 包周期资源各状态倒计时呈现Code：正常状态（hws_countdown_period_using）、到期进入宽限期（hws_countdown_period_gracing）、到期冻结（hws_countdown_period_frozen）、违规冻结（hws_countdown_period_illegalfrozen）、公安冻结（hws_countdown_period_policefrozen） 枚举值： hws_countdown_period_using hws_countdown_period_gracing hws_countdown_period_frozen hws_countdown_period_illegalfrozen hws_countdown_period_policefrozen countdown_infos countdown_infos object 倒计时信息，包含资源状态、到期处理策略、到期剩余时间 countdown_tips countdown_tips object 倒计时tips信息，包含资源生效、失效、冻结、释放时间以及宽限期到期时间 表8 countdown_infos 参数 参数类型 描述 status Integer 资源当前状态：未生效（1）、生效中（2）、已删除（3）、冻结中（4）、宽限期中（5）、违规冻结或公安冻结（99） 最小值：1 最大值：99 next_operation_policy Integer 下一步操作的处理策略/到期处理策略：到期进入宽限期（0）、无宽限期和保留期场景到期后自动删除（2）、宽限期到期冻结（4）、宽限期到期后删除（5） 最小值：0 最大值：5 next_operation_remaining_day Integer 当前状态到下一步操作执行还剩下的天数 最小值：0 最大值：365 next_operation_remaining_hour Integer 当前状态到下一步操作执行还剩下的小时数 最小值：0 最大值：24 next_operation_remaining_minute Integer 当前状态到下一步操作执行还剩下的分钟数 最小值：0 最大值：60 next_operation_remaining_second Integer 当前状态到下一步操作执行还剩下的秒数 最小值：0 最大值：60 表9 countdown_tips 参数 参数类型 描述 eff_time String 资源生效时间 exp_time String 资源失效时间 grace_time String 资源宽限期结束时间 frozen_time String 资源冻结时间 release_time String 资源释放时间 状态码： 400 表10 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度：3 最大长度：3 error_code String 错误码 最小长度：12 最大长度：12 error_msg String 错误信息 最小长度：1 最大长度：65535 message String 错误详细信息 最小长度：1 最大长度：65535 状态码： 401 表11 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度：3 最大长度：3 error_code String 错误码 最小长度：12 最大长度：12 error_msg String 错误信息 最小长度：1 最大长度：65535 message String 错误详细信息 最小长度：1 最大长度：65535 状态码： 500 表12 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度：3 最大长度：3 error_code String 错误码 最小长度：12 最大长度：12 error_msg String 错误信息 最小长度：1 最大长度：65535 message String 错误详细信息 最小长度：1 最大长度：65535

URI GET /v2/{project_id}/huaweicloudchain/instances/{instance_id}/organization 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 最小长度：32 最大长度：32 instance_id 是 String 实例ID 最小长度：36 最大长度：36 表2 Query参数 参数 是否必选 参数类型 描述 name 是 String 组织名称 最小长度：4 最大长度：16

调用API获取项目ID 项目ID还用通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”，其中{Endpoint}为IAM的终端节点。接口的认证鉴权请参考认证鉴权。 响应示例如下，其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "project_name", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 bcs Detail object 区块链实例创建状态 eip Detail object 弹性IP创建状态 sfs Detail object 弹性文件存储创建状态 obs Detail object OBS实例创建状态 kafka Detail object kafka实例创建状态 cce ComCCE object 云容器引擎创建状态 表4 ComCCE 参数 参数类型 描述 cluster Detail object 云容器引擎集群创建状态 network Detail object 云容器引擎网络创建状态 security_group Detail object 云容器引擎安全组创建状态 表5 Detail 参数 参数类型 描述 start_time String 开始时间 end_time String 结束时间 status String 状态 枚举值： waiting deploying finished failed detail 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 { "bcs" : { "start_time" : "2020-10-15T18:24:48.658236618+08:00", "end_time" : "2020-10-15T18:25:53.552512674+08:00", "status" : "finished", "detail" : "" }, "eip" : { "start_time" : "2020-10-15T18:24:31.957780831+08:00", "end_time" : "2020-10-15T18:24:33.810699517+08:00", "status" : "finished", "detail" : "" }, "sfs" : { "start_time" : "2020-10-15T18:24:31.957781285+08:00", "end_time" : "2020-10-15T18:24:48.611812564+08:00", "status" : "finished", "detail" : "" } } 状态码： 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" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result String 请求结果 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

请求示例 { "inviter_bcsid" : "a30962b6-xxxxx-f7ff1a0ec561", "inviter_projectid" : "b45a57xxxxx8a5", "inviter_domainid" : "a38c7xxxxd374d", "inviter_username" : "bcs-test", "channel_name" : "channel", "invitee_bcsid" : "e97ae066-xxxxx-f6bdb4fd3df1", "invitee_projectid" : "e64e7xxxxx65e1", "invitee_domainid" : "a38c7xxxxx374d" }

响应示例 状态码： 200 Ok { "result" : "success", "operation_id" : "BCSSVC01-03-1617158790255323683" } 状态码： 400 Bad Request { "error_code" : "BCS.4006003", "error_msg" : "Invalid Parameter notification status" } 状态码： 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 Ok { "count" : 1, "operation_records" : [ { "operation_id" : "BCSSVC01-99-1618218591906093855", "resource_type" : "BCSSVC01", "operation_type" : "99", "domain_id" : "051ddda36880d3420f9bc01403fd8da0", "project_id" : "051ddda57400d2982fccc014fab5749d", "blockchain_id" : "23604f57-eac9-3777-e9f5-ae87457f2338", "blockchain_name" : "bcs-i3b0ms", "cluster_info" : { "cluster_type" : "cce", "name" : "asdfasf", "cluster_id" : "4df5652f-96dc-11eb-b49c-0255ac100b08", "node_infos" : null }, "operation_process" : { "Create Other Dependent Resource" : { "step_name" : "Create Other Dependent Resource", "status" : "processing", "detail" : "", "sub_steps" : { "Create EIP" : { "substep_name" : "Create EIP", "detail" : null, "status" : "finished", "message" : null, "start_time" : 1618219038464462600, "end_time" : 1618219038464462600, "serial_num" : 1 }, "Create network storage" : { "substep_name" : "Create network storage", "detail" : "waiting", "status" : "", "message" : null, "start_time" : 0, "end_time" : 0, "serial_num" : 2 } }, "serial_num" : 2 }, "Preparation" : { "step_name" : "Preparation", "status" : "finished", "detail" : "", "sub_steps" : { "Generate basic configurations" : { "substep_name" : "Generate basic configurations", "detail" : null, "status" : "finished", "message" : null, "start_time" : 1618218591951266000, "end_time" : 1618218591951266000, "serial_num" : 3 } }, "serial_num" : 1 } }, "record_time" : 1618218591906100000, "operation_status" : "processing", "message" : null, "desc" : null } ] } 状态码： 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" }

URI GET /v2/{project_id}/operation/record 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户从IAM申请到的项目ID，一般为32位字符串 表2 Query参数 参数 是否必选 参数类型 描述 blockchain_id 否 String 区块链ID operation_status 否 String 操作状态, 可选数值如下（括号中为该数值对应的操作状态含义）：waiting(等待执行)，processing（处理中），finished（操作完成，成功），failed（操作失败），stop（操作中断） 枚举值： waiting processing finished failed stop resource_type 否 String 资源类型, 可选数值如下（括号中为该数值对应的资源类型含义）：BCSSVC01（BCS变更操作），BCSSVC02（UGBaaS变更操作），PLUGIN01（RestAPI插件变更操作），PLUGIN02（TC3插件变更操作），PLUGIN03（轻节点插件变更操作） 枚举值： BCSSVC01 BCSSVC02 PLUGIN01 PLUGIN02 PLUGIN03 operation_type 否 String 操作类型, 可选数值如下（括号中为该数值对应的操作类型含义）：99（OpCreate）,00（OpDelete）,01（OpUpgrade）,91（OpUpgradeRb）,02（OpAddOrg）,03（OpScaleOrg）,04（OpJoinChannel）,05（OpJoinUnion） 枚举值： 99 00 01 91 02 03 04 05 operation_id 否 String 操作记录ID

响应示例 状态码： 200 请求成功 { "id" : "0720097286db7edf8627b1eb4b0c9acfd64ba1092bf1472035c7ed1efc0dc048", "type" : "COMMON_TRANSACTION", "status" : "VALID", "block_height" : 2, "create_org" : "org1-jeij39jfo", "contract_name" : "test", "endorsor_orgs" : [ "org1-jeij39jfo" ], "read_set" : [ ], "write_set" : [ "key:\"BS_ADDRESS\" value:\"x.x.x.x\" " ], "create_time" : "2022-04-26T12:37:16Z" }

URI GET /v2/{project_id}/huaweicloudchain/instances/{instance_id}/chain/transactions/{transaction_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 最小长度：32 最大长度：32 instance_id 是 String 实例ID 最小长度：36 最大长度：36 transaction_id 是 String 交易ID 最小长度：64 最大长度：64

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 交易ID type String 交易类型：普通交易（COMMON_TRANSACTION）、投票交易（VOTE_TRANSACTION） status String 交易状态 block_height Integer 交易所属区块高度 create_org String 交易发起组织 contract_name String 交易执行合约 endorsor_orgs Array of objects 背书组织 数组长度：1 - 100 read_set Array of KeyVersion objects 交易读集 数组长度：0 - 500 write_set Array of files 交易写集 数组长度：0 - 500 create_time String 交易创建时间 表4 KeyVersion 参数 参数类型 描述 key String 交易数据的key version version object 交易数据的版本数据 表5 version 参数 参数类型 描述 block_num Integer 区块号 tx_num Integer 交易序号 状态码： 400 表6 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度：3 最大长度：3 error_code String 错误码 最小长度：12 最大长度：12 error_msg String 错误信息 最小长度：1 最大长度：65535 message String 错误详细信息 最小长度：1 最大长度：65535 状态码： 401 表7 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度：3 最大长度：3 error_code String 错误码 最小长度：12 最大长度：12 error_msg String 错误信息 最小长度：1 最大长度：65535 message String 错误详细信息 最小长度：1 最大长度：65535 状态码： 500 表8 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度：3 最大长度：3 error_code String 错误码 最小长度：12 最大长度：12 error_msg String 错误信息 最小长度：1 最大长度：65535 message String 错误详细信息 最小长度：1 最大长度：65535