华为云用户手册

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 组织用户加密消息 组织用户加密消息。 组织用户解密消息 组织用户解密消息。 父主题： 华为云区块链引擎管理

请求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在同一个区域也相同，所以简洁起见将这两部分省略。

请求消息头 附加请求头字段，如指定的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

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 GET：请求服务器返回指定资源。 PUT：请求服务器更新指定资源。 POST：请求服务器新增资源或执行特殊操作。 DELETE：请求服务器删除指定资源，如删除对象等。 HEAD：请求服务器资源头部。 PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： 1 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中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。

响应示例 状态码： 200 请求成功 { "block_height" : 1, "transaction_num" : 1, "body_hash" : "sDkqoUXCuDPJHBeV5FOpDBh1RygliHVEA0LqhPCZSuk=", "parent_hash" : "Pr25oSO7eImsxLFXUgppq3Q76QYcF1Rn6WiSMDkIh+g=", "create_time" : "2022-04-26T12:37:16Z"}

响应消息体 响应消息体通常以结构化格式（如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表示错误描述信息。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 block_height String 区块高度 transaction_num Integer 区块包含交易数量 body_hash String 区块hash parent_hash String 父区块hash create_time String 区块创建时间 状态码： 400 表4 响应Body参数 参数 参数类型 描述 code String 状态码 error_code String 错误码 error_msg String 错误信息 message String 错误详细信息 状态码： 401 表5 响应Body参数 参数 参数类型 描述 code String 状态码 error_code String 错误码 error_msg String 错误信息 message String 错误详细信息 状态码： 500 表6 响应Body参数 参数 参数类型 描述 code String 状态码 error_code String 错误码 error_msg String 错误信息 message String 错误详细信息

响应示例 状态码： 200 请求成功 { "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 表3 响应Body参数 参数 参数类型 描述 id String 实例ID name String 实例名称 status String 实例状态：正常（Available）、不可用（Unavailable）、异常（Exception）、待付款（Unpaid）、创建中（Creating）、删除中（Deleting）、升级中（Upgrading）、组织创建中（OrgCreating）、组织删除中（OrgDeleting） edition String 版本类型: 专业版（Professional）、企业版（Enterprise）、铂金版（Platinum） kind String 实例类型，HuaweiCloudChain，Besu data_management String 数据管理模式：云端管理（Cloud） chain_engine_version String 实例区块链引擎版本 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 企业项目名称 表4 InstanceOrg 参数 参数类型 描述 name String 组织名称 status String 组织状态：正常（Available）、不可用（Unavailable）、异常（Exception）、待付款（Unpaid）、创建中（Creating）、删除中（Deleting） is_consensus Boolean 是否为共识组织，共识组织为true，非共识组织为false 表5 InstanceChain 参数 参数类型 描述 chain_id String 链ID consensus ConsensusType object 区块链共识类型：raft sign_algorithm String 区块链签名算法：ECDSA（ecdsa_with_sha256）、国密（sm2_with_sm3） contract_num Integer 合约数量 block_num Integer 区块数量 transaction_num Integer 交易数量 表6 ConsensusType 参数 参数类型 描述 - String 区块链共识类型：raft,IBFT2.0 状态码： 400 表7 响应Body参数 参数 参数类型 描述 code String 状态码 error_code String 错误码 error_msg String 错误信息 message String 错误详细信息 状态码： 401 表8 响应Body参数 参数 参数类型 描述 code String 状态码 error_code String 错误码 error_msg String 错误信息 message String 错误详细信息 状态码： 500 表9 响应Body参数 参数 参数类型 描述 code String 状态码 error_code String 错误码 error_msg String 错误信息 message String 错误详细信息

请求示例 { "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 表3 请求Body参数 参数 是否必选 参数类型 描述 edition 是 String 版本类型: 专业版（Professional）、企业版（Enterprise）、铂金版（Platinum） org_num 是 Integer 订购组织数量 charge_mode 否 Integer 资源计费模式:包周期计费（0），默认0值 period_type 是 Integer 订购周期类型:按月（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 产品实付金额 original_amount Integer 产品原始金额 currency String 币种:人民币（CNY） 状态码： 400 表5 响应Body参数 参数 参数类型 描述 code String 状态码 error_code String 错误码 error_msg String 错误信息 message String 错误详细信息 状态码： 401 表6 响应Body参数 参数 参数类型 描述 code String 状态码 error_code String 错误码 error_msg String 错误信息 message String 错误详细信息 状态码： 500 表7 响应Body参数 参数 参数类型 描述 code String 状态码 error_code String 错误码 error_msg String 错误信息 message String 错误详细信息

基本概念 账号 用户注册账号时，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用该用户进行日常管理工作。 用户 由账号在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。 父主题： 使用前必读

响应消息体 响应消息体通常以结构化格式（如JSON或XML）返回，与响应消息头中Content-Type对应，传递除响应消息头之外的内容。 对于获取IAM用户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表示错误描述信息。

支持的授权项 策略支持的操作与API相对应，授权项列表说明如下： 权限：允许或拒绝某项操作。 对应API接口：自定义策略实际调用的API接口。 授权项：自定义策略中支持的Action，在自定义策略中的Action中写入授权项，可以实现授权项对应的权限功能。 依赖的授权项：部分Action存在对其他Action的依赖，需要将依赖的Action同时写入授权项，才能实现对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project)： 自定义策略的授权范围，包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目，表示此授权项对应的自定义策略，可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目，不支持企业项目，表示仅能在IAM中给用户组授权并生效，如果在企业管理中授权，则该自定义策略不生效。关于IAM项目与企业项目的区别，详情请参见：IAM与企业管理的区别。 如果您需要允许或者禁止某个接口的操作权限，请使用策略。使用策略时，注意事项如下： 目前只有基于已有集群创建的区块链实例支持细粒度授权功能，区块链所使用的集群需要进行权限预处理，应使用具有CCE Administrator及以上权限的账号在CCE控制台的权限管理页面为指定集群授予命名空间权限。例如为具有 BCS Fabric ReadOnlyAccess权限的用户组授予view命名空间权限，为具有B CS Fabric FullAcces权限的用户组授予cluster admin命名空间权限。具体操作请参考CCE命名空间权限。 若用户想要查询委托状态，则需额外授予IAM ReadOnlyAccess。若需要授权委托，请联系具有Security Administrator角色的账号进行授权。 如果需要创建包周期区块链实例，需要额外授予BSS Operator角色。请勿将BCS Fabric ReadOnlyAccess和BSS的角色放在一起使用，以免造成意外退订。 请勿将Tenant Guest角色与BCS Fabric FullAccess策略放在一起使用，否则会造成部分功能界面隐藏。 企业项目授权时，由于依赖服务的个别接口未实现基于企业项目的权限管理，需要在IAM用户组授予对应的项目权限。例如创建实例需要同时授予VPC ReadOnlyAccess项目权限，查看监控需要同时授予 AOM ReadOnlyAccess项目权限，查看合约实例需要同时授予CloudIDE ReadOnlyAccess项目权限，增加组织需要同时授予SFS Turbo ReadOnlyAccess项目权限。

自定义策略授权项 Hyperledger Fabric增强版支持自定义策略授权项如下所示： 表格中“√”表示支持，“×”表示暂不支持。 表1 Hyperledger Fabric增强版常用操作与系统权限关系 接口 对应的API接口 授权项 IAM项目 (Project) 企业项目 (Enterprise Project) 查询配额 GET /v2/{project_id}/quotas bcs:fabricInstance:listQuota √ √ 查询规格 GET /v2/{project_id}/blockchains/flavors bcs:fabricInstance:getFlavor √ √ 查询异步操作结果 GET /v2/{project_id}/operation/record bcs:fabricInstance:listRecord √ √ 创建服务实例 POST /v2/{project_id}/blockchains bcs:fabricInstance:createOnDemand √ √ 查询服务实例列表 GET /v2/{project_id}/blockchains bcs:fabricInstance:list √ √ 查询创建状态 GET /v2/{project_id}/blockchains/{blockchain_id}/status bcs:fabricInstance:getStatus √ √ 查询实例信息 GET /v2/{project_id}/blockchains/{blockchain_id} bcs:fabricInstance:getDetail √ √ 查询节点信息 GET /v2/{project_id}/blockchains/{blockchain_id}/nodes bcs:fabricInstance:getNodes √ √ 修改服务实例 PUT /v2/{project_id}/blockchains/{blockchain_id} bcs:fabricInstance:update √ √ 删除服务实例 DELETE /v2/{project_id}/blockchains/{blockchain_id} bcs:fabricInstance:delete √ √ 下载证书 GET /v2/{project_id}/blockchains/{blockchain_id}/cert bcs:fabricInstance:downloadCert √ √ 下载SDK配置 POST /v2/{project_id}/blockchains/{blockchain_id}/sdk-cfg bcs:fabricInstance:downloadSdkCfg √ √ 生成用户证书 POST /v2/{project_id}/blockchains/{blockchain_id}/orgs/{org_name}/usercert/{user_name} bcs:fabricInstance:createUserCert √ √ 冻结用户证书 POST /v2/{project_id}/blockchains/{blockchain_id}/orgs/{org_name}/usercert/{user_name}/freeze bcs:fabricInstance:freezeUserCert √ √ 解冻用户证书 POST /v2/{project_id}/blockchains/{blockchain_id}/orgs/{org_name}/usercert/{user_name}/unfreeze bcs:fabricInstance:unfreezeUserCert √ √ 查询服务实例监控数 POST /v2/{project_id}/blockchains/{blockchain_id}/metric/list bcs:fabricInstance:listInstanceMetric √ √ 查询BCS组织监控数据列 POST /v2/{project_id}/blockchains/{blockchain_id}/entity/metric/list bcs:fabricInstance:listOrgMetric √ √ 查询BCS组织实例监控数 POST /v2/{project_id}/blockchains/{blockchain_id}/entity/instance/metric/list bcs:fabricInstance:getOrgMetric √ √ 创建通道 POST /v2/{project_id}/blockchains/{blockchain_id}/channels bcs:fabricChannel:create √ √ 查询通道信息 GET /v2/{project_id}/blockchains/{blockchain_id}/channels bcs:fabricChannel:list √ √ peer节点加入通道 POST /v2/{project_id}/blockchains/{blockchain_id}/channels/peers bcs:fabricChannel:addPeer √ √ BCS某个组织中的节点退出某通 PUT /v2/{project_id}/blockchains/{blockchain_id}/{channel_id}/peers/quit bcs:fabricChannel:removePeer √ √ BCS组织退出某通道 PUT /v2/{project_id}/blockchains/{blockchain_id}/{channel_id}/orgs/quit bcs:fabricChannel:removeOrg √ √ BCS删除某个通道 DELETE /v2/{project_id}/blockchains/{blockchain_id}/channel/{channel_id} bcs:fabricChannel:delete √ √ 邀请联盟成员 POST /v2/{project_id}/members/invitations bcs:fabricMember:createInvitation √ √ 删除邀请成员信息 DELETE /v2/{project_id}/members/invitations bcs:fabricMember:deleteInvitation √ √ 获取联盟成员列表 GET /v2/{project_id}/members bcs:fabricMember:list √ √ 被邀请方退出指定联盟 PUT /v2/{project_id}/members/quit bcs:fabricMember:quit √ √ 获取全部通知 GET /v2/{project_id}/notifications bcs:fabricNotification:list √ √ 处理联盟邀请 POST /v2/{project_id}/notification/handle bcs:fabricNotification:handle √ √ 父主题： 权限策略说明

URI GET /v2/{project_id}/besu/instances/{instance_id}/chain/transactions/{transaction_hash} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID instance_id 是 String 实例ID transaction_hash 是 String besu交易hash

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 hash String 交易hash from String 目标地址 to String 源地址 block_height Integer 交易所属区块高度 contract_address String 合约地址 data String 交易数据 create_time String 交易创建时间 状态码： 400 表4 响应Body参数 参数 参数类型 描述 code String 状态码 error_code String 错误码 error_msg String 错误信息 message String 错误详细信息 状态码： 401 表5 响应Body参数 参数 参数类型 描述 code String 状态码 error_code String 错误码 error_msg String 错误信息 message String 错误详细信息 状态码： 500 表6 响应Body参数 参数 参数类型 描述 code String 状态码 error_code String 错误码 error_msg String 错误信息 message String 错误详细信息

响应示例 状态码： 200 请求成功 { "hash" : "0xa029938c2d96fa2fea6d427fc9b496d0b5b1567fcf3d482d726aeaca6928fb37", "from" : "0x8867c17e38a8bf8cefd755e5a469b5fdfcae859d", "to" : "0x8867c17e38a8bf8cefd755e5a469b5fdfcae859d", "block_height" : 0, "contract_address" : "string", "data" : "string", "create_time" : "string"}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 tags Array of ResourceTag objects 资源标签列表 表4 ResourceTag 参数 参数类型 描述 key String 键。最大长度128个字符，可以包含任意语种字母， 数字，空格和_ . : = + - @，但首尾不能含有空格, 不能以_sys_开头。 value String 值。每个值最大长度255个字符，可以包含任意语种字母， 数字，空格和_.:/=+-@。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 code String 状态码 error_code String 错误码 error_msg String 错误信息 message String 错误详细信息 状态码： 401 表6 响应Body参数 参数 参数类型 描述 code String 状态码 error_code String 错误码 error_msg String 错误信息 message String 错误详细信息 状态码： 403 表7 响应Body参数 参数 参数类型 描述 code String 状态码 error_code String 错误码 error_msg String 错误信息 message String 错误详细信息 状态码： 404 表8 响应Body参数 参数 参数类型 描述 code String 状态码 error_code String 错误码 error_msg String 错误信息 message String 错误详细信息 状态码： 500 表9 响应Body参数 参数 参数类型 描述 code String 状态码 error_code String 错误码 error_msg String 错误信息 message String 错误详细信息

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

URI GET /v2/{project_id}/huaweicloudchain/instances/{instance_id}/chain/transactions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID instance_id 是 String 实例ID 表2 Query参数 参数 是否必选 参数类型 描述 block_height 是 String 区块ID offset 否 Integer 分页查询起始位置 limit 否 Integer 每页返回的条目数量

响应示例 状态码： 200 请求成功 { "count" : 1, "txs" : [ { "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" } ]}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 endpoint_num Integer 终端节点个数 endpoint_service_name String 终端节点服务名称 endpoint_service_status String 终端节点服务状态：未创建（uncreated）、创建中（creating）、可连接（available）、失败（failed）、删除中（deleting） 状态码： 400 表4 响应Body参数 参数 参数类型 描述 code String 状态码 error_code String 错误码 error_msg String 错误信息 message String 错误详细信息 状态码： 401 表5 响应Body参数 参数 参数类型 描述 code String 状态码 error_code String 错误码 error_msg String 错误信息 message String 错误详细信息 状态码： 500 表6 响应Body参数 参数 参数类型 描述 code String 状态码 error_code String 错误码 error_msg String 错误信息 message String 错误详细信息

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 备份id name String 备份名称 instance_id String 实例id instance_name String 实例名称 instance_edition String 实例版本类型 instance_consensus String 实例共识 instance_sign_algorithm String 实例签名算法 instance_org String 组织信息 enterprise_project_id String 企业项目id enterprise_project_name String 企业项目名称 status String 状态 reason String 失败原因 type String 备份方式 create_time String 备份时间 状态码： 400 表4 响应Body参数 参数 参数类型 描述 code String 状态码 error_code String 错误码 error_msg String 错误信息 message String 错误详细信息 状态码： 401 表5 响应Body参数 参数 参数类型 描述 code String 状态码 error_code String 错误码 error_msg String 错误信息 message String 错误详细信息 状态码： 403 表6 响应Body参数 参数 参数类型 描述 code String 状态码 error_code String 错误码 error_msg String 错误信息 message String 错误详细信息 状态码： 500 表7 响应Body参数 参数 参数类型 描述 code String 状态码 error_code String 错误码 error_msg String 错误信息 message String 错误详细信息

响应示例 状态码： 200 请求成功 { "id" : "string", "name" : "string", "instance_id" : "string", "instance_name" : "string", "instance_edition" : "string", "instance_consensus" : "string", "instance_sign_algorithm" : "string", "instance_org" : "string", "enterprise_project_id" : "string", "enterprise_project_name" : "string", "status" : "string", "reason" : "string", "type" : "string", "create_time" : "string"}

状态码 状态码如表1所示 表1 状态码 状态码 编码 状态码说明 100 Continue 继续请求。 这个临时响应用来通知客户端，它的部分请求已经被服务器接收，且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如，切换到HTTPS的新版本协议。 200 Success 请求成功。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 203 Non-Authoritative Information 非授权信息，请求成功。 204 NoContent 请求完全成功，同时HTTPS响应不包含响应体。 在响应OPTIONS方法的HTTPS请求时返回此状态码。 205 Reset Content 重置内容，服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置，相应可返回一个资源特征与地址的列表用于用户终端（例如：浏览器）选择。 301 Moved Permanently 永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。 使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改，服务器返回此状态码时，不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTPS状态码。 400 BadRequest 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 NotFound 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 405 MethodNotAllowed 请求中带有该资源不支持的方法。 建议直接修改该请求，不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证，与401类似，但请求者应当使用代理进行授权。 408 Request Time-out 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。 返回该状态码，表明请求的资源已被永久删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大，服务器无法处理，因此拒绝请求。为防止客户端的连续请求，服务器可能会关闭连接。如果只是服务器暂时无法处理，则会包含一个Retry-After的响应信息。 414 Request-URI Too Large 请求的URI过长（URI通常为网址），服务器无法处理。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 416 Requested range not satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 UnprocessableEntity 请求格式正确，但是由于含有语义错误，无法响应。 429 TooManyRequests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部，然后等待该首部指出的时间后再重试。 500 InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能，无法完成请求。 502 Bad Gateway 充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。 503 ServiceUnavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。 504 ServerTimeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时（Timeout）参数时会得到该响应。 505 HTTPS Version not supported 服务器不支持请求的HTTPS协议的版本，无法完成处理。 父主题： 附录

调用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" }}

创建联盟成员 接口相关信息 URI格式：POST /v2/{project_id}/members/invitations 请求示例 POST https://{bcs_endpoint}/ v2/{project_id}/members/invitations {bcs_endpoint}信息请从地区和终端节点获取。 Body： { "bcs_id": "ba0fc16d-c752-9ac4-7a43-7a84443e0a06", "channel_name": "channel", "invitor_username": "paas_bcs_c00218797_02", "invited_userinfo": [ { "invited_username": "paas_bcs_bwx705565_02" } ]} 响应示例 正确响应返回body为空。