华为云用户手册

  • 操作流程 介绍在“CodeArts IDE Online”中,CodeArts IDE Online的基本使用流程:创建IDE实例、启动IDE实例、CodeArts IDE Online编码、CodeArts IDE Online调试。 流程说明如下: 流程 说明 创建IDE实例 进入CodeArts IDE Online服务“我的IDE”页签,单击左上角“新建实例”,创建IDE实例。 启动IDE实例 创建IDE实例后会自动启动IDE实例,也可以在CodeArts IDE Online服务“我的IDE”页签单击实例卡片上,启动IDE实例。 CodeArts IDE Online编码 在CodeArts IDE Online中,可以编写代码,并对代码进行提交、构建和运行。 CodeArts IDE Online调试 在CodeArts IDE Online中,运行已提交的代码后,可以对代码进行在线调试。
  • HBase/CloudTable增量迁移 使用 CDM 导出HBase(包括 MRS HBase、 FusionInsight HBase、Apache HBase)或者 表格存储服务 (CloudTable)的数据时,支持导出指定时间段内的数据,配合CDM的定时任务,可以实现HBase/CloudTable的增量迁移。 如果配置了时间宏变量,通过 DataArts Studio 数据开发调度CDM迁移作业时,系统会将时间宏变量替换为(数据开发作业计划启动时间-偏移量),而不是(CDM作业实际启动时间-偏移量)。 在创建CDM表/文件迁移的作业,源连接选择为HBase连接或CloudTable连接时,高级属性的可选参数中可以配置时间区间。 图1 HBase时间区间 起始时间(包含该值),格式为“yyyy-MM-dd HH:mm:ss”,表示只抽取该时间及以后的数据。 终止时间(不包含该值),格式为“yyyy-MM-dd HH:mm:ss”,表示只抽取该时间以前的数据。 这2个参数支持配置为时间宏变量,例如: 起始时间配置为${dateformat(yyyy-MM-dd HH:mm:ss, -1, DAY)}时,表示只导出昨天以后的数据。 终止时间配置为${dateformat(yyyy-MM-dd HH:mm:ss)}时,表示只导出当前时间以前的数据。 这2个参数同时配置后,CDM就只导出前一天内的数据,再将该作业配置为每天0点执行一次,就可以增量同步每天新生成的数据。 父主题: 增量迁移原理介绍
  • 处理方法 检查浏览器网络连接是否正常。若无网络连接,请修复网络连接。刷新页面重试,若仍加载失败,请参照2继续排查处理。 如果电脑使用的是无线网络环境,请确保连接的稳定。 检查是否有proxy拦截。若已拦截,请解除拦截后刷新页面重试。 如果页面中的错误提示为“Connection got disposed”,在完成前两个步骤后仍无法正常加载页面,请尝试联系网络服务提供方确认其是否对websocket进行拦截。解除拦截后刷新页面重试。
  • 使用Open API创建的实例如何自动安装指定插件? 使用Open API创建的实例自动安装指定插件,目前可通过以下两种途径实现: 在实例的API参数“plugin_enable_list”中传入插件id,插件id是由插件作者和插件名组成,格式为“publisher.name”。 通过实例URL地址拼接的方式, 在“preinstallPlugins”传入插件id。 const envParams = { preinstallPlugins: []}url = url + `&&session_env=${encodeURIComponent(JSON.stringify(envParams))}`
  • 策略及授权项说明 如果您需要对您所拥有的华为云 区块链 引擎服务进行精细的权限管理,您可以使用 统一身份认证 服务(Identity and Access Management,简称 IAM ),如果华为云帐号已经能满足您的要求,不需要创建独立的IAM用户,您可以跳过本章节,不影响您使用华为云区块链引擎服务的其它功能。 策略是以JSON格式描述权限集的语言。默认情况下,新建的IAM用户没有任何权限,您需要将其加入用户组,并给用户组授予策略,才能使用户组中的用户获得策略定义的权限,这一过程称为授权。授权后,用户就可以基于策略对云服务进行操作。 根据授权的精细程度,分为角色和策略。角色以服务为粒度,是IAM最初提供的一种根据用户的工作职能定义权限的粗粒度授权机制。策略以API接口为粒度进行权限拆分,授权更加精细,可以精确到某个操作、资源和条件,能够满足企业对权限最小化的安全管控要求。 华为云区块链引擎的策略说明请参考权限管理。 如果您需要允许或者禁止某个接口的操作权限,请使用策略。 支持的授权项 策略支持的操作与API相对应,授权项列表说明如下: 权限:允许或拒绝某项操作。 对应API接口:自定义策略实际调用的API接口。 授权项:自定义策略中支持的Action,在自定义策略中的Action中写入授权项,可以实现授权项对应的权限功能。 依赖的授权项:部分Action存在对其他Action的依赖,需要将依赖的Action同时写入授权项,才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project): 自定义策略的授权范围,包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目,表示此授权项对应的自定义策略,可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目,不支持企业项目,表示仅能在IAM中给用户组授权并生效,如果在企业管理中授权,则该自定义策略不生效。关于IAM项目与企业项目的区别,详情请参见:IAM与企业管理的区别。 父主题: 权限策略说明
  • 请求消息体 请求消息体通常以结构化格式发出,与请求消息头中Content-type对应,传递除请求消息头之外的内容。若请求消息体中参数支持中文,则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同,也并不是每个接口都需要有请求消息体(或者说消息体为空),GET、DELETE操作类型的接口就不需要消息体,消息体具体内容需要根据具体接口而定。 对于获取用户Token接口,您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示,加粗的斜体字段需要根据实际值填写,其中username为用户名,domainname为用户所属的帐号名称,********为用户登录密码,cn-north-4为项目名称,获取方法请参考终端节点。 scope参数定义了Token的作用域,下面示例中获取的Token仅能访问project下的资源。您还可以设置Token作用域为某个帐号下所有资源或帐号的某个project下的资源,详细定义请参考获取用户Token。 非华为云帐号 获取Token 请参考获取用户Token。 1 2 3 4 5 6 7 8 91011121314151617181920212223242526 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokensContent-Type: application/json{ "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "cn-north-4" } } }} 到这里为止这个请求需要的内容就具备齐全了,您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口,返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后,您就可以使用Token认证调用其他API。
  • 请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中,但大多数语言或框架都要求您从请求消息中单独传递它,所以在此单独强调。 URI-scheme: 表示用于传输请求的协议,当前所有API均采用HTTPS协议。 Endpoint: 指定承载REST服务端点的服务器域名或IP,不同服务不同区域的Endpoint不同,您可以从地区和终端节点获取。 例如:HBS服务在“华北-北京四”区域的Endpoint为“bcs.cn-north-4.myhuaweicloud.com”。 resource-path: 资源路径,也即API访问路径。从具体API的URI模块获取,例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string: 查询参数,是可选部分,并不是每个API都有查询参数。查询参数前面需要带一个“?”,形式为“参数名=参数取值”,例如“limit=10”,表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京四”区域的Token,则需使用“华北-北京四”区域的Endpoint(iam.cn-north-4.myhuaweicloud.com),并在获取用户Token的URI部分找到resource-path(/v3/auth/tokens),拼接起来如下所示。 1 https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便,在每个具体API的URI部分,只给出resource-path部分,并将请求方法写在一起。这是因为URI-scheme都是HTTPS,而Endpoint在同一个区域也相同,所以简洁起见将这两部分省略。
  • 请求方法 HTTP请求方法(也称为操作或动词),它告诉服务你正在请求什么类型的操作。 GET:请求服务器返回指定资源。 PUT:请求服务器更新指定资源。 POST:请求服务器新增资源或执行特殊操作。 DELETE:请求服务器删除指定资源,如删除对象等。 HEAD:请求服务器资源头部。 PATCH:请求服务器更新资源的部分内容。当资源不存在的时候,PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分,您可以看到其请求方法为“POST”,则其请求为: 1 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens
  • 请求消息头 附加请求头字段,如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“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认证。 对于获取用户Token接口,由于不需要认证,所以只添加“Content-Type”即可,添加消息头后的请求如下所示。 12 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokensContent-Type: application/json
  • 调用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" }}
  • 响应消息体 响应消息体通常以结构化格式(如JSON或XML)返回,与响应消息头中Content-Type对应,传递除响应消息头之外的内容。 对于获取用户Token接口,返回如下消息体。为篇幅起见,这里只展示部分内容。 1 2 3 4 5 6 7 8 9101112 { "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表示错误描述信息。
  • 购买一个组织 接口相关信息 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" : " CS 2205101612RBMZD", "order_num" : 1, "instance_id" : "e224e6b6-e215-11ec-9675-0255ac101552", "job_id" : "e9541c1a-e17e-11ec-9826-0255ac10040d"}
  • 请求示例 { "orgs" : [ { "name" : "org1" }, { "name" : "org2" } ], "org_order_info" : { "charge_mode" : 0, "period_type" : 2, "period_num" : 1, "is_auto_pay" : true, "is_auto_renew" : true }} { "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" }}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 最小长度:1 最大长度:65535 表3 请求Body参数 参数 是否必选 参数类型 描述 orgs 是 Array of CreateOrg objects 需要创建的组织信息,专业版最多订购2个组织,企业版最多订购10个组织,铂金版最多订购100个组织 org_order_info 是 Object 订购相关信息 表4 CreateOrg 参数 是否必选 参数类型 描述 name 是 String 组织名称,长度限制4-16,支持小写字母、数字,且必须以小写字母开头 表5 org_order_info 参数 是否必选 参数类型 描述 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必须同时填写,填写一个视为不参与促销活动
  • 响应参数 状态码: 200 表6 响应Body参数 参数 参数类型 描述 order_id String 订购生成的订单ID order_num Integer 订购资源数量 最小值:1 最大值:100 instance_id String 实例ID job_id String 资源创建Job ID 状态码: 400 表7 响应Body参数 参数 参数类型 描述 code String 状态码 最小长度:3 最大长度:3 error_code String 错误码 最小长度:12 最大长度:12 error_msg String 错误信息 最小长度:1 最大长度:65535 message String 错误详细信息 最小长度:1 最大长度:65535 状态码: 401 表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
  • 响应参数 状态码: 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
  • URI POST /v2/{project_id}/{resource_type}/{instance_id}/tags/create 表1 路径参数 参数 是否必选 参数类型 描述 resource_type 是 String 资源类型,当前仅支持华为云区块链引擎类型:huaweicloudchain project_id 是 String 项目ID 最小长度:32 最大长度:32 instance_id 是 String 实例ID 最小长度:36 最大长度:36
  • 请求参数 表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个字符,可以包含任意语种字母, 数字,空格和_.:/=+-@。
  • 响应示例 状态码: 200 请求成功 { "count" : 1, "contracts" : [ { "name" : "test01", "version" : "1.0", "type" : "go", "status" : "Success", "description" : "", "failed_message" : "", "chain_id" : "default", "install_orgs" : [ "organization" ], "endorse_orgs" : [ "organization" ], "endorse_policy" : "OR", "file_hash_code" : "da366b9aac3fee0a54888f5d5ad94b4f57468fc43ecd29ffa2ec3b1e367bd35b", "security_check" : true, "security_check_status" : 2, "install_time" : "2022-04-29T01:30:50Z" } ]}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 合约总数量 最小值:0 最大值:100 contracts Array of ContractInfo objects 合约列表 表5 ContractInfo 参数 参数类型 描述 name String 合约名称 version String 合约版本号 最小长度:2 最大长度:14 type String 合约类型:Go语言类型(go)、Solidity语言类型(solidity) 枚举值: go solidity status String 合约状态:安装中(Installing)、安装失败(Failed)、安装完成(Success) 枚举值: Installing Failed Success failed_message String 合约安装失败详细错误信息 description String 合约描述 chain_id String 合约所属链ID install_orgs Array of strings 合约安装组织 endorse_orgs Array of strings 合约背书组织 endorse_policy String 合约背书策略:任意组织背书(OR)、全部组织背书(AND) 枚举值: OR AND file_hash_code String 合约文件SHA256哈希值 最小长度:64 最大长度:64 security_check Boolean 合约是否开启安全检查任务 security_check_status Integer 合约安全检查任务状态:不存在(0)、正在执行(1)、完成(2)、失败(3) 最小值:0 最大值:3 install_time String 合约安装时间 状态码: 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
  • URI GET /v2/{project_id}/huaweicloudchain/instances/{instance_id}/chain/contracts 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 最小长度:32 最大长度:32 instance_id 是 String 实例ID 最小长度:36 最大长度:36 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 分页查询起始位置 最小值:0 limit 否 Integer 每页返回的条目数量 最小值:1 最大值:500
  • URI GET /v2/{project_id}/huaweicloudchain/instances 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 最小长度:32 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 分页查询起始位置 最小值:0 limit 否 Integer 每页返回的条目数量 最小值:1 最大值:100
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 实例总数量 最小值:0 最大值:100 instances Array of InstanceInfo objects 实例列表 表5 InstanceInfo 参数 参数类型 描述 id String 实例ID name String 实例名称 status String 实例状态:正常(Available)、不可用(Unavailable)、异常(Exception)、待付款(Unpaid)、创建中(Creating)、删除中(Deleting)、升级中(Upgrading)、组织创建中(OrgCreating)、组织删除中(OrgDeleting) 枚举值: Available Unavailable Unpaid Creating Deleting Upgrading OrgCreating OrgDeleting edition String 版本类型: 专业版(Professional)、企业版(Enterprise)、铂金版(Platinum) data_management String 数据管理模式:云端管理(Cloud) chain_engine_version String 实例区块链引擎版本 最小长度:7 最大长度:10 orgs Array of InstanceOrg objects 实例组织信息 chains Array of InstanceChain objects 实例链信息 create_time String 实例创建时间 update_time String 实例数据更新时间 enterprise_project_id String 企业项目id enterprise_project_name String 企业项目名称 表6 InstanceOrg 参数 参数类型 描述 name String 组织名称 status String 组织状态:正常(Available)、不可用(Unavailable)、异常(Exception)、待付款(Unpaid)、创建中(Creating)、删除中(Deleting) is_consensus Boolean 是否为共识组织,共识组织为true,非共识组织为false 表7 InstanceChain 参数 参数类型 描述 chain_id String 链ID consensus String 区块链共识类型:raft sign_algorithm String 区块链签名算法:ECDSA(ecdsa_with_sha256)、国密(sm2_with_sm3) contract_num Integer 合约数量 最小值:0 最大值:100 block_num Integer 区块数量 transaction_num Integer 交易数量 状态码: 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
  • 响应示例 状态码: 200 请求成功 { "count" : 1, "instances" : [ { "id" : "e543adf0-c61e-11ec-a1c5-0255ac100408", "name" : "huawei-chain-01", "status" : "Available", "edition" : "Professional", "data_management" : "Cloud", "chain_engine_version" : "1.0.1.2", "orgs" : [ { "name" : "org1", "status" : "Available", "is_consensus" : true }, { "name" : "org2", "status" : "Available", "is_consensus" : false } ], "chains" : [ { "chain_id" : "huawei-chain-01-egger394n", "consensus" : "raft", "sign_algorithm" : "ecdsa_with_sha256", "contract_num" : 1, "block_num" : 5, "transaction_num" : 9 } ], "create_time" : "2022-04-16T07:20:05Z", "update_time" : "2022-04-16T07:20:05Z", "enterprise_project_id" : "0", "enterprise_project_name" : "default" } ]}
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 符合条件的job总数量,最大1000 最小值:0 最大值:2000 jobs Array of JobInfo objects job列表 表5 JobInfo 参数 参数类型 描述 id String job ID type Object job类型:创建实例(CreateInstance)、删除实例(DeleteInstance)、升级区块链引擎(UpgradeChainEngine)、创建组织(CreateOrganization)、删除组织(DeleteOrganization) 枚举值: CreateInstance DeleteInstance UpgradeChainEngine CreateOrganization DeleteOrganization status String job状态:初始化(Initializing)、运行中(Running)、失败(Failed)、成功(Success) 枚举值: Initializing Running Failed Success failed_message String job失败详细描述信息 progress Integer job完成百分比 最小值:0 最大值:100 instance_id String job相关的实例ID instance_name String job相关的实例名称 start_time String job起始时间 end_time String job结束时间 状态码: 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
  • 响应示例 状态码: 200 请求成功 { "count" : 1, "jobs" : [ { "id" : "a75e800b-bd4c-11ec-a5fe-0255ac100409", "type" : "CreateInstance", "status" : "Success", "failed_message" : "", "progress" : 100, "instance_id" : "37f60ab6-bbeb-11ec-9396-0255ac100408", "instance_name" : "cce-test-01", "start_time" : "2022-04-16T07:20:05Z", "end_time" : "2022-04-16T07:40:05Z" } ]}
  • URI GET /v2/{project_id}/huaweicloudchain/jobs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 最小长度:32 最大长度:32 表2 Query参数 参数 是否必选 参数类型 描述 status 否 String job状态:初始化(Initializing)、运行中(Running)、失败(Failed)、成功(Success);支持多个状态联合查询,以逗号分隔 最小长度:6 最大长度:40 start_time 否 String 查询job起始UTC时间,格式为RFC 3339标准时间格式,eg:2022-07-07T13:00:29Z 最小长度:1 最大长度:32 instance_name 否 String Job关联实例名称,支持模糊查询,区分大小写 最小长度:1 最大长度:24 offset 否 Integer 分页查询起始位置 最小值:0 limit 否 Integer 每页返回的条目数量 最小值:1 最大值:100
  • 响应示例 状态码: 200 请求成功 { "block_height" : 1, "transaction_num" : 1, "body_hash" : "sDkqoUXCuDPJHBeV5FOpDBh1RygliHVEA0LqhPCZSuk=", "parent_hash" : "Pr25oSO7eImsxLFXUgppq3Q76QYcF1Rn6WiSMDkIh+g=", "create_time" : "2022-04-26T12:37:16Z"}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 block_height String 区块高度 transaction_num Integer 区块包含交易数量 最小值:1 最大值:500 body_hash String 区块体hash parent_hash String 父区块hash create_time String 区块创建时间 状态码: 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
  • URI GET /v2/{project_id}/huaweicloudchain/instances/{instance_id}/chain/blocks/{block_height} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID 最小长度:32 最大长度:32 instance_id 是 String 实例ID 最小长度:36 最大长度:36 block_height 是 Integer 区块高度,最大值为当前链最新区块高度 最小值:0
共100000条