华为云用户手册

  • 响应示例 状态码: 200 请求成功 { "chain_engine_version" : "1.0.1.2", "editions" : [ { "name" : "Professional", "max_org_num" : 2, "tps_limit" : 2000 }, { "name" : "Enterprise", "max_org_num" : 10, "tps_limit" : 10000 }, { "name" : "Platinum", "max_org_num" : 100, "tps_limit" : 50000 } ], "plugins" : [ { "type" : "e2ee", "version" : "1.0.0.2" } ]}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 chain_engine_version String 当前最新 区块链 引擎版本 最小长度:7 最大长度:10 editions Array of ServiceFlavor objects 服务支持规格详情 plugins Array of ServiceSupportPlugin objects 服务插件 表4 ServiceFlavor 参数 参数类型 描述 name String 版本类型: 专业版(Professional)、企业版(Enterprise)、铂金版(Platinum) 枚举值: Professional Enterprise Platinum max_org_num Integer 最大组织数:专业版最多2个组织,企业版最多10个组织,铂金版最多100个组织 最小值:2 最大值:100 tps_limit Integer 区块链最高tps:专业版2000tps,企业版10000tps,铂金版50000tps 最小值:2000 最大值:50000 表5 ServiceSupportPlugin 参数 参数类型 描述 type String 插件类型 version String 插件版本 状态码: 401 表6 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535
  • 响应示例 状态码: 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"}
  • 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
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 uid String 组织资源ID name String 组织名称 chain_org_id String 组织在链上的ID status String 组织状态:正常(Available)、异常(Exception)、不可用(Unavailable)、待付款(Unpaid)、创建中(Creating)、删除中(Deleting) is_consensus Boolean 是否为共识组织,共识组织为true,非共识组织为false capacity_info Object 组织磁盘容量相关信息 subscription_id String 资源对应的订购实例ID,可用于组织退订 order_info Object 组织订购相关信息 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 Object 倒计时信息,包含资源状态、到期处理策略、到期剩余时间 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
  • 请求示例 { "edition" : "Professional", "org_num" : 1, "charge_mode" : 0, "period_type" : 2, "period_num" : 1, "promotion_id" : "P22020702520656805DMA6A0R1WKID", "discount_plan_id" : "PDP2204021323287781B6J25H1RUC643"}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 最小长度:1 最大长度:65535 表3 请求Body参数 参数 是否必选 参数类型 描述 edition 是 String 版本类型: 专业版(Professional)、企业版(Enterprise)、铂金版(Platinum) 枚举值: Professional Enterprise Platinum org_num 是 Integer 订购组织数量 最小值:1 最大值:100 charge_mode 否 Integer 资源计费模式:包周期计费(0),默认0值 枚举值: 0 period_type 是 Integer 订购周期类型:按月(2)、按年(3) 枚举值: 2 3 period_num 是 Integer 订购周期数量,按年只可以询价一年,按月可以询价1-9个月,超过9个月相当于一年 promotion_id 否 String 促销活动ID,促销活动目标用户可使用;一次促销活动可包含多个促销计划,参与促销活动时promotion_id和discount_plan_id必须同时填写,填写一个视为不参与促销活动 discount_plan_id 否 String 折扣计划ID,促销活动目标用户可使用;参与促销活动时promotion_id和discount_plan_id必须同时填写,填写一个视为不参与促销活动
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 amount Integer 产品实付金额 最小值:1 最大值:40000000 original_amount Integer 产品原始金额 最小值:1 最大值:48000000 currency String 币种:人民币(CNY) 枚举值: CNY 状态码: 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 请求成功 { "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
  • 购买HBS实例 接口相关信息 URI格式 :POST /v2/{project_id}/huaweicloudchain/instances 请求示例 POST https://{bcs_endpoint}/v2/{project_id}/huaweicloudchain/instances {bcs_endpoint}信息请从地区和终端节点获取,{project_id}信息请参考获取项目ID。 Body: "name" : "huawei-chain-01", "edition" : "Professional", "data_management" : "Cloud", "orgs" : [ { "name" : "org1" }, { "name" : "org2" } ], "chain_info" : { "consensus" : "raft", "sign_algorithm" : "ecdsa_with_sha256" }, "org_order_info" : { "charge_mode" : 0, "period_type" : 2, "period_num" : 1, "is_auto_pay" : true, "is_auto_renew" : true }} 响应示例 { "order_id" : " CS 2205101612RBMZD", "order_num" : 2, "instance_id" : "e224e6b6-e215-11ec-9675-0255ac101552", "job_id" : "e9541c1a-e17e-11ec-9826-0255ac10040d"}
  • 响应参数 状态码: 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 背书组织 read_set Array of KeyVersion objects 交易读集 write_set Array of strings 交易写集 create_time String 交易创建时间 表4 KeyVersion 参数 参数类型 描述 key String 交易数据的key 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
  • API概览 通过使用华为云区块链引擎服务所提供的管理接口,您可以通过调用API使用华为云区块链引擎服务的功能,包括HBS实例的创建、查询,更新等,接口说明如表1所示。 表1 API概览 类型 API 说明 服务管理 查询服务信息 查询服务规格详情。 询价 产品询价。 查询总览信息 查询总览信息。 任务管理 查询job详情 查询job详情,Job由后台自动创建,Job ID可通过列表查询接口获取。 查询job列表 查询租户job列表,单次最多查询100个。 批量删除job 批量删除job,单次最多删除100个。 实例管理 购买实例 购买区块链实例。 查询实例列表 查询区块链实例列表,单次最多查询100个。 查询实例详情 查询区块链实例详情。 更新实例 更新实例:升级区块链引擎。 组织管理 购买组织 购买组织。 查询组织列表 查询实例组织列表,单次最多查询100个。 查询组织详情 查询组织详情。 区块链管理 查询链详情 查询链详情。 查询区块列表 查询区块列表,逆序查询,单次查询限制500个,只支持云端管理实例使用。 查询区块详情 查询区块详情,只支持云端管理实例使用。 查询区块交易列表 查询区块交易列表,单次最多查询500笔,只支持云端管理实例使用。 查询交易详情 查询交易详情,只支持云端管理实例使用。 查询区块、交易统计结果 查询区块、交易统计结果,只支持云端管理实例使用。 下载SDK配置 下载区块链SDK配置文件,只支持云端管理实例使用。 合约管理 安装合约 安装或者更新合约,只支持云端管理实例使用。 查询合约详情 查询合约详情,只支持云端管理实例使用。 查询合约列表 查询合约列表,单次最多查询500个,只支持云端管理实例使用。 获取合约扫描报告 获取合约安全扫描报告,只支持云端管理实例使用,接口返回内容为扫描报告zip文件的字节流。 终端节点管理 创建终端节点 创建 VPC终端节点 ,只支持云端管理实例使用。 查询终端节点列表 查询终端节点列表,单次最多查询100个,只支持云端管理实例使用且只返回创建成功的终端节点。 查询终端节点服务详情 查询终端节点服务详情,只支持云端管理实例使用。 标签管理 查询资源标签 查询资源标签。 批量添加资源标签 批量添加资源标签。 批量删除资源标签 批量删除资源标签。 E2EE 组织用户加密消息 组织用户加密消息。 组织用户解密消息 组织用户解密消息。
  • 基本概念 帐号 用户注册帐号时,帐号对其所拥有的资源及云服务具有完全的访问权限,可以重置用户密码、分配用户权限等。由于帐号是付费主体,为了确保帐号安全,建议您不要直接使用帐号进行日常管理工作,而是创建用户并使用他们进行日常管理工作。 用户 由帐号在 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。 父主题: 使用前必读
  • 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....”加到请求消息头即可,如下所示。 123 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/projectsContent-Type: application/jsonX-Auth-Token: ABCDEFJ....
  • 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不同,使用时请注意。
  • 响应参数 状态码: 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
  • 请求示例 { "cert_path" : "opt/temp", "download_ca" : false, "orgs" : [ "org1-engj39dn7" ], "access_mode" : "StandardChannel"} { "cert_path" : "opt/temp", "download_ca" : true, "orgs" : [ "org1-engj39dn7" ], "access_mode" : "HighPerformanceChannel", "endpoint_ip" : "x.x.x.x"}
  • 状态码 状态码 描述 200 请求成功返回配置文件字节流,配置文件为zip格式,包含组织客户端配置文件和相关证书;客户端配置文件以“链ID-组织ID-sdk.yaml”命名;证书路径为:用户输入路径/orgcerts/组织ID/证书文件名;证书包含组织CA(ca.key、ca.crt)、组织CA通信证书(ca_tls.crt)、用户身份证书(user_sign.key、user_sign.crt)、用户通信证书(user_tls.key、user_tls.crt) 400 请求参数校验不通过 401 鉴权失败 500 服务内部执行错误
  • 请求参数 表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 access_mode 是 String 区块链后台访问方式:标准通道(StandardChannel)、高性能通道(HighPerformanceChannel) 枚举值: StandardChannel HighPerformanceChannel endpoint_ip 否 String 终端节点IP,选择高性能通道时必填
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 transaction_id String 消息加密后对应的交易ID,用于查询解密后明文 最小长度:64 最大长度:64 data_to_chain Array of strings 非代为上链场景下,加密后的密文,需要在SDK侧完成上链 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:0 最大长度:15 error_msg String 错误信息 最小长度:16 最大长度:200
  • 请求示例 加密一条消息,允许组织ID为“organization2-kdkvs88qk”的组织解密该消息,由E2EE服务代为上链,不更新组秘钥。url中变量{domain}由服务IP地址和端口号组成。从 BCS 实例的插件管理页面可以获取服务ip地址,插件详情页面可以获取组织的端口号。 https://{{domain}}/v1/e2ee/org/encrypt{ "message" : "hello, this test message", "target_org_ids" : [ "organization2-kdkvs88qk" ], "up_to_chain" : true, "update_group_key" : false}
  • 请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 target_org_ids 是 Array of strings 可以解密消息的组织ID 最小长度:14 最大长度:24 message 是 String 组织的用户输入需要加密的信息 最小长度:1 最大长度:65535 up_to_chain 否 Boolean 是否加密后发送到链上,默认为true,加密后直接上链 枚举值: true false update_group_key 否 Boolean 是否更新组秘钥 枚举值: true false
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 最小长度:1 最大长度:65535 表3 请求Body参数 参数 是否必选 参数类型 描述 tags 是 Array of ResourceTag objects 标签列表 表4 ResourceTag 参数 是否必选 参数类型 描述 key 是 String 键。最大长度128个字符,可以包含任意语种字母, 数字,空格和_ . : = + - @,但首尾不能含有空格, 不能以_sys_开头。 value 是 String 值。每个值最大长度255个字符,可以包含任意语种字母, 数字,空格和_.:/=+-@。
  • URI DELETE /v2/{project_id}/{resource_type}/{instance_id}/tags/delete 表1 路径参数 参数 是否必选 参数类型 描述 resource_type 是 String 资源类型,当前仅支持华为云区块链引擎类型:huaweicloudchain project_id 是 String 项目ID 最小长度:32 最大长度:32 instance_id 是 String 实例ID 最小长度:36 最大长度:36
  • 响应参数 状态码: 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 状态码: 403 表7 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535 状态码: 404 表8 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535 状态码: 500 表9 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535
  • 响应参数 状态码: 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
  • 请求示例 { "name" : "huawei-chain-01", "edition" : "Professional", "enterprise_project_id" : "bd33ecd4-89cd-442c-abd0-3ba88aedd40c", "data_management" : "Cloud", "orgs" : [ { "name" : "org1" }, { "name" : "org2" } ], "chain_info" : { "consensus" : "raft", "sign_algorithm" : "ecdsa_with_sha256" }, "org_order_info" : { "charge_mode" : 0, "period_type" : 2, "period_num" : 1, "is_auto_pay" : true, "is_auto_renew" : true }} { "name" : "huawei-chain-02", "edition" : "Professional", "data_management" : "Cloud", "enterprise_project_id" : "0", "orgs" : [ { "name" : "org1" }, { "name" : "org2" } ], "org_order_info" : { "charge_mode" : 0, "period_type" : 2, "period_num" : 1, "is_auto_pay" : false, "is_auto_renew" : true, "promotion_id" : "P22020702520656805DMA6A0R1WKID", "discount_plan_id" : "PDP2204021323287781B6J25H1RUC643" }}
  • 响应参数 状态码: 200 表7 响应Body参数 参数 参数类型 描述 order_id String 订购生成的订单ID order_num Integer 订购资源数量 最小值:1 最大值:100 instance_id String 实例ID job_id String 资源创建Job ID 状态码: 400 表8 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535 状态码: 401 表9 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535 状态码: 500 表10 响应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参数 参数 是否必选 参数类型 描述 name 是 String 实例名称,长度限制4-24,支持英文、数字、中划线,不能以中划线开头 edition 是 String 版本类型: 专业版(Professional)、企业版(Enterprise)、铂金版(Platinum) 枚举值: Professional Enterprise Platinum data_management 是 String 数据管理模式:云端管理(Cloud) orgs 是 Array of CreateOrg objects 需要创建的组织信息 chain_info 否 CreateChain object 链配置信息 org_order_info 否 CreateOrgOrderInfo object 实例组织订购相关信息 enterprise_project_id 否 String 企业项目id,不填默认为“0”,即default企业项目。说明:关于企业项目ID的获取及企业项目特性的详细信息,请参见《企业管理用户指南》 表4 CreateOrg 参数 是否必选 参数类型 描述 name 是 String 组织名称,长度限制4-16,支持小写字母、数字,且必须以小写字母开头 表5 CreateChain 参数 是否必选 参数类型 描述 consensus 否 String 区块链共识类型:raft 枚举值: raft sign_algorithm 否 String 区块链签名算法:ECDSA(ecdsa_with_sha256)、国密(sm2_with_sm3),专业版当前不支持国密 枚举值: ecdsa_with_sha256 sm2_with_sm3 表6 CreateOrgOrderInfo 参数 是否必选 参数类型 描述 charge_mode 否 Integer 资源计费模式:包周期计费(0),默认0值处理 枚举值: 0 period_type 否 Integer 订购周期类型:按月(2)、按年(3) 枚举值: 2 3 period_num 否 Integer 订购周期数量,按年只允许购买一年,按月可以购买1-9个月,超过9个月等同于一年 is_auto_pay 否 Boolean 是否自动付款,true支持自动付款,false不支持自动付款 is_auto_renew 否 Boolean 是否自动续费,true支持自动续费,false不支持自动续费 promotion_id 否 String 促销活动ID,促销活动目标用户可使用;一次促销活动可包含多个促销计划,参与促销活动时promotion_id和discount_plan_id必须同时填写,填写一个视为不参与促销活动 discount_plan_id 否 String 折扣计划ID,促销活动目标用户可使用;参与促销活动时promotion_id和discount_plan_id必须同时填写,填写一个视为不参与促销活动
共100000条