华为云用户手册

请求示例 { "orgID" : "ce0ac69b0c8648cd25b44a551780409767c8890b", "channelID" : "mychannel", "cryptoMethod" : "SW", "cert" : "-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----", "sk" : "-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----", "timestamp" : "2020-10-27T17:28:16+08:00", "currentPage" : "string", "pageSizeNum" : "string", "provider" : "string", "searchText" : "string", "status" : "string"}

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 items Array of DatasetResponse objects 列表 pagination PaginationResp object 分页信息 表3 DatasetResponse 参数 参数类型 描述 provider String 数据集提供者身份标识 providerName String 数据集提供者名称 productName String 数据集产品名称 productID String 数据集产品id sampleUrl String 样例数据url sampleSize String 样例数据大小 sampleType String 样例数据类型 sampleName String 样例数据名称 fileType String 文件类型 dataUrl String 数据url dataHash String 数据哈希值 dataSize String 数据大小 dataName String 数据名称 description String 数据描述 price String 数据价格 encryptedAesKey String 密钥 status String 状态 publishTime String 数据发布时间 dataFiles Array of DataFile objects 数据文件列表 sampleFiles Array of DataFile objects 样例文件列表 category String 加密类型 表4 DataFile 参数 参数类型 描述 fileType String 文件类型 dataUrl String 数据url dataHash String 数据哈希 dataSize String 数据大小 dataName String 数据名称 表5 PaginationResp 参数 参数类型 描述 currentPage Integer 当前页码 pageSizeNum Integer 每页条数 totalItems Integer 总条数 状态码： 500 表6 响应Body参数 参数 参数类型 描述 errorCode String 错误码 errorMsg String 错误描述

请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 orgID 是 String 组织id channelID 是 String 通道id cryptoMethod 是 String 加密方法，目前固定为SW cert 是 String 证书 sk 是 String 私钥 timestamp 是 String 时间戳 currentPage 否 String 分页参数：当前页码（默认1） pageSizeNum 否 String 分页参数：每页条数(默认100) provider 否 String 过滤条件：发布者身份标识 searchText 否 String 过滤条件：匹配关键字（基于数据集中的产品名称、产品描述信息） status 否 String 过滤条件：数据集状态（ready、closed）

请求示例 { "orgID" : "ce0ac69b0c8648cd25b44a551780409767c8890b", "channelID" : "mychannel", "cryptoMethod" : "SW", "cert" : "-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----", "sk" : "-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----", "timestamp" : "2020-10-27T17:28:16+08:00", "consumer" : "did:example:3TMWx8owKHARgNwbj4ywmG", "orderSeq" : "1"}

请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 orgID 是 String 组织id channelID 是 String 通道id cryptoMethod 是 String 加密方法，目前固定为SW cert 是 String 证书 sk 是 String 私钥 timestamp 是 String 时间戳 consumer 是 String 订单申请者身份标识 orderSeq 是 String 订单序列号

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 consumer String 订单消费者身份标识 consumerName String 订单消费者名称 orderSeq String 订单序列号 provider String 订单提供者身份标识 providerName String 订单提供者名称 productID String 数据集产品id productName String 数据集产品名称 price String 订单价钱 applyTime String 订单申请时间 encryptedAesKey String 密钥 status String 订单状态 reason String 订单申请原因 lockProof String 订单锁定证明 creatorDID String 流程创建者DID，如果没有加入任何流程，为“” processID String 当前订单所属流程ID，如果没有加入任何流程，为“” 状态码： 500 表3 响应Body参数 参数 参数类型 描述 errorCode String 错误码 errorMsg String 错误描述

响应示例 状态码： 200 订单信息 { "consumer" : "did:example:3TMWx8owKHARgNwbj4ywmG", "consumerName" : "Tyler", "orderSeq" : "1", "provider" : "did:example:DHkJjyD5wZwya6sd6BNBnG", "providerName" : "hw", "productID" : "product1", "productName" : "prodname1", "price" : "0", "applyTime" : "1607332359", "encryptedAesKey" : "BNGhPwjaTgpM+V7czzw1i4mH21KKN+XLKXHLqVsRIfybUCncqZNfomkRfzX4WEHj+oty1X9oCd4h6xMnRvs8BWE5Tvg6BJ6QTW/km9EO/FSYqzJf2GqQzAleAcLJrTBZ3LRbPaF87CgJ114ae7R+VK9VvfXQ8exuH2KMRD305dXieGpM4VPVv9u1BbL15Jpd/g==", "status" : "ready", "reason" : "I want product1", "lockProof" : ""} 状态码： 500 失败响应 { "errorCode" : "BCS.5002046", "errorMsg" : "Incorrect number of arguments"}

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 creatorDID String 流程创建者身份标识 processID String 流程ID stages Array of StageInProcess objects 流程中的阶段信息 表3 StageInProcess 参数 参数类型 描述 stageName String 阶段名称 createTime String 阶段信息上链时间戳 consumer String 消费者身份标识 orderSeq String 订单序列号 状态码： 500 表4 响应Body参数 参数 参数类型 描述 errorCode String 错误码 errorMsg String 错误描述

请求示例 /v1/datashare/dataset/query-process{ "orgID" : "{{orgID}}", "channelID" : "{{channelID}}", "cryptoMethod" : "{{cryptoMethod}}", "cert" : "{{cert}}", "sk" : "{{sk}}", "timestamp" : "{{timestamp}}", "creatorDID" : "did:example:8sAvsS4tB3NYgMJ4uqbVYj", "processID" : "a779dd88-f7a3-4ac9-bf1c-a0ed1d827632"}

响应示例 状态码： 200 查询指定的数据集分享流程响应参数 { "creatorDID" : "did:example:YLgvmFcukyigJpRsqRbFMn", "processID" : "25f46489-29bb-4f58-8f4c-e12da0a4bd66", "stages" : [ { "stageName" : "transaction1", "createTime" : "1640574210", "consumer" : "did:example:My8PRB5dKDVvBKXT76oJoB", "orderSeq" : "8zLQUpyswA8kpiHEsAUhZN" }, { "stageName" : "transaction2", "createTime" : "1640574304", "consumer" : "did:example:T1kFDUQAqo2z2X7hJWiRtQ", "orderSeq" : "3oKCPSKLGvaebT6z3a4PvY" }, { "stageName" : "transaction2", "createTime" : "1640587323", "consumer" : "did:example:T1kFDUQAqo2z2X7hJWiRtQ", "orderSeq" : "GPSta7mTScEEaQVRB62wUF" }, { "stageName" : "transaction2", "createTime" : "1640680918", "consumer" : "did:example:T1kFDUQAqo2z2X7hJWiRtQ", "orderSeq" : "8kzahSLi2kBxY8GGBZdLhp" } ]}

请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 orgID 是 String 组织id channelID 是 String 通道id cryptoMethod 是 String 加密方法，目前固定为SW cert 是 String 证书 sk 是 String 私钥 timestamp 是 String 时间戳 creatorDID 是 String 流程创建者身份标识 processID 是 String 流程ID

请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 orgID 是 String 组织id channelID 是 String 通道id cryptoMethod 是 String 加密方法，目前固定为SW cert 是 String 用户证书，每行末尾均需要增加显式换行符\n sk 是 String 用户私钥，每行末尾均需要增加显式换行符\n timestamp 是 String 时间戳

请求示例 { "orgID" : "4f1439758ebb41f7411b5f684b67713c08b89198", "channelID" : "channel", "cryptoMethod" : "SW", "cert" : "-----BEGIN CERTIFICATE-----\n...\n...\n-----END CERTIFICATE-----", "sk" : "------BEGIN PUBLIC KEY-----\n...\n...\n-----END PUBLIC KEY-----", "timestamp" : "2020-10-27T17:28:16+08:00"}

请求示例 { "orgID" : "ce0ac69b0c8648cd25b44a551780409767c8890b", "channelID" : "mychannel", "cryptoMethod" : "SW", "cert" : "-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----", "sk" : "-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----", "timestamp" : "2020-10-27T17:28:16+08:00", "currentPage" : "string", "pageSizeNum" : "string", "provider" : "string", "searchText" : "string", "status" : "string", "consumer" : "did:example:3TMWx8owKHARgNwbj4ywmG"}

响应示例 状态码： 200 订单分页信息 { "items" : [ { "consumer" : "did:example:3TMWx8owKHARgNwbj4ywmG", "consumerName" : "Tyler", "orderSeq" : "1", "provider" : "did:example:DHkJjyD5wZwya6sd6BNBnG", "providerName" : "hw", "productID" : "product1", "productName" : "prodname1", "price" : "0", "applyTime" : "1607332359", "encryptedAesKey" : "BNGhPwjaTgpM+V7czzw1i4mH21KKN+XLKXHLqVsRIfybUCncqZNfomkRfzX4WEHj+oty1X9oCd4h6xMnRvs8BWE5Tvg6BJ6QTW/km9EO/FSYqzJf2GqQzAleAcLJrTBZ3LRbPaF87CgJ114ae7R+VK9VvfXQ8exuH2KMRD305dXieGpM4VPVv9u1BbL15Jpd/g==", "status" : "ready", "reason" : "I want product1", "lockProof" : "" } ], "pagination" : { "currentPage" : 1, "pageSizeNum" : 100, "totalItems" : 10 }} 状态码： 500 失败响应 { "errorCode" : "BCS.5002046", "errorMsg" : "Incorrect number of arguments"}

请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 orgID 是 String 组织id channelID 是 String 通道id cryptoMethod 是 String 加密方法，目前固定为SW cert 是 String 证书 sk 是 String 私钥 timestamp 是 String 时间戳 currentPage 否 String 分页参数：当前页码（默认1） pageSizeNum 否 String 分页参数：每页条数(默认100) provider 否 String 过滤条件：订单中数据集发布者身份标识 searchText 否 String 过滤条件：匹配关键字（订单的产品名称） status 否 String 过滤条件：订单状态（ready、finished、failed、canceled） consumer 否 String 过滤条件：订单消费者身份标识

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 items Array of DataOrderResponse objects 列表 pagination PaginationResp object 分页信息 表3 DataOrderResponse 参数 参数类型 描述 consumer String 订单消费者身份标识 consumerName String 订单消费者名称 orderSeq String 订单序列号 provider String 订单提供者身份标识 providerName String 订单提供者名称 productID String 数据集产品id productName String 数据集产品名称 price String 订单价钱 applyTime String 订单申请时间 encryptedAesKey String 密钥 status String 订单状态 reason String 订单申请原因 lockProof String 订单锁定证明 creatorDID String 流程创建者DID，如果没有加入任何流程，为“” processID String 当前订单所属流程ID，如果没有加入任何流程，为“” 表4 PaginationResp 参数 参数类型 描述 currentPage Integer 当前页码 pageSizeNum Integer 每页条数 totalItems Integer 总条数 状态码： 500 表5 响应Body参数 参数 参数类型 描述 errorCode String 错误码 errorMsg String 错误描述

请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 orgID 是 String 组织id channelID 是 String 通道id cryptoMethod 是 String 加密方法,目前固定为SW cert 是 String 证书 sk 是 String 私钥 timestamp 是 String 时间戳 provider 是 String 授权者的身份标识 applyer 是 String 申请者的身份标识

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 applyer String 申请者的身份标识 applyerName String 申请者的名称 provider String 授权者的身份标识 providerName String 授权者的名称 service String 授权者的服务名 price Integer 价格 applyTime String 申请时间 encryptedABEKey String 被加密的ABE密钥 status String 申请状态，request表示未授权；ready表示申请已处理 reason String 原因 lockProof String 证明 attributesJson String 属性 状态码： 500 表3 响应Body参数 参数 参数类型 描述 errorCode String 错误码 errorMsg String 错误描述

响应示例 状态码： 200 ABE用户密钥订单信息 { "applyer" : "did:hwid:mfqqdiW8V64JbPFgQsoiv", "applyerName" : "", "provider" : "did:hwid:FahQr32NgQZWjGRiCZc37C", "providerName" : "", "service" : "", "price" : 0, "applyTime" : "1672985584", "encryptedABEKey" : "", "status" : "ready", "reason" : "", "lockProof" : "", "attributesJson" : "{\"att1\":\"YXR0MW5hbWU=\",\"att2\":\"YXR0Mm5hbWU=\",\"att3\":\"NQ==\"}"} 状态码： 500 失败响应 { "errorCode" : "BCS.5002046", "errorMsg" : "Incorrect number of arguments"}

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 items Array of DatasetShareProcessResponseBody objects 数据集分享流程列表 pagination PaginationResp object 分页信息 表3 DatasetShareProcessResponseBody 参数 参数类型 描述 creatorDID String 流程创建者身份标识 processID String 流程ID stages Array of StageInProcess objects 流程中的阶段信息 表4 StageInProcess 参数 参数类型 描述 stageName String 阶段名称 createTime String 阶段信息上链时间戳 consumer String 消费者身份标识 orderSeq String 订单序列号 表5 PaginationResp 参数 参数类型 描述 currentPage Integer 当前页码 pageSizeNum Integer 每页条数 totalItems Integer 总条数 状态码： 500 表6 响应Body参数 参数 参数类型 描述 errorCode String 错误码 errorMsg String 错误描述

请求示例 /v1/datashare/dataset/query-processes{ "orgID" : "{{orgID}}", "channelID" : "{{channelID}}", "cryptoMethod" : "{{cryptoMethod}}", "cert" : "{{cert}}", "sk" : "{{sk}}", "timestamp" : "{{timestamp}}", "creatorDID" : "did:example:8sAvsS4tB3NYgMJ4uqbVYj", "currentPage" : "1", "pageSizeNum" : "100"}

响应示例 状态码： 200 查询指定流程创建者的所有流程响应参数 { "items" : [ { "creatorDID" : "did:example:8sAvsS4tB3NYgMJ4uqbVYj", "processID" : "442a6b42-82b7-415a-a0e6-deaaee59f582", "stages" : [ { "stageName" : "Seconde transaction", "createTime" : "1639824526", "consumer" : "did:example:8sAvsS4tB3NYgMJ4uqbVYj", "orderSeq" : "N6UhspZ5cQY7NtHsxuFTZ" } ] }, { "creatorDID" : "did:example:8sAvsS4tB3NYgMJ4uqbVYj", "processID" : "a779dd88-f7a3-4ac9-bf1c-a0ed1d827632", "stages" : [ { "stageName" : "First transaction", "createTime" : "1639824239", "consumer" : "did:example:8sAvsS4tB3NYgMJ4uqbVYj", "orderSeq" : "FKCx1Cfatj7RRsKMWPQ7wQ" }, { "stageName" : "", "createTime" : "1639826471", "consumer" : "did:example:8sAvsS4tB3NYgMJ4uqbVYj", "orderSeq" : "8PuuWWg521bZDXadzwPdMn" }, { "stageName" : "Seconde transaction", "createTime" : "1639826898", "consumer" : "did:example:8sAvsS4tB3NYgMJ4uqbVYj", "orderSeq" : "SCkh1rQ6aD5SYTYkojn44W" } ] }, { "creatorDID" : "did:example:8sAvsS4tB3NYgMJ4uqbVYj", "processID" : "d15b5213-5cb8-4af4-97dc-143379369f35", "stages" : [ { "stageName" : "564econde transaction", "createTime" : "1639827681", "consumer" : "did:example:8sAvsS4tB3NYgMJ4uqbVYj", "orderSeq" : "XCXtVZsdKFDLaErzpSZYAN" } ] } ], "pagination" : { "currentPage" : 1, "pageSizeNum" : 100, "totalItems" : 3 }}

请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 orgID 是 String 组织id channelID 是 String 通道id cryptoMethod 是 String 加密方法，目前固定为SW cert 是 String 证书 sk 是 String 私钥 timestamp 是 String 时间戳 currentPage 否 String 分页参数：当前页码（默认1） pageSizeNum 否 String 分页参数：每页条数(默认100) creatorDID 是 String 流程创建者身份标识

请求示例 { "orgID" : "ce0ac69b0c8648cd25b44a551780409767c8890b", "channelID" : "mychannel", "cryptoMethod" : "SW", "cert" : "-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----", "sk" : "-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----", "timestamp" : "2020-10-27T17:28:16+08:00", "owner" : "did:example:8poVETnVCry9ecfHSDeQaR"}

请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 orgID 是 String 组织id channelID 是 String 通道id cryptoMethod 是 String 加密方法,目前固定为SW cert 是 String 证书 sk 是 String 私钥 timestamp 是 String 时间戳 owner 是 String 密钥生成者的身份标识 keyManagerMode 否 String abe系统首次使用时，需选择中心模式“central”或者多中心模式“distributed”，该模式仅可选择一次，默认为多中心模式。

请求示例 { "orgID" : "4f1439758ebb41f7411b5f684b67713c08b89198", "channelID" : "mychannel", "cryptoMethod" : "SW", "cert" : "-----BEGIN CERTIFICATE-----\n...\n...\n-----END CERTIFICATE-----", "sk" : "------BEGIN PRIVATE KEY-----\n...\n...\n-----END PRIVATE KEY-----", "timestamp" : "2020-10-27T17:28:16+08:00", "service" : [ { "type" : "VerifiableCredentialService", "serviceEndpoint" : "https://example.com/vc/", "credentialApplySchema" : { "type" : "file", "name" : "Test Enterprise Certification", "description" : "this is test apply info", "attributes" : [ { "name" : "bob", "type" : "string", "description" : "Attribute's description" } ] } } ]}

请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 orgID 是 String 组织id channelID 是 String 通道id cryptoMethod 是 String 加密方法，目前固定为SW cert 是 String 用户证书，每行末尾均需要增加显式换行符\n sk 是 String 用户私钥，每行末尾均需要增加显式换行符\n timestamp 是 String 时间戳 service 是 Array of DIDService objects 提供的服务 表2 DIDService 参数 是否必选 参数类型 描述 type 是 String 类型 serviceEndpoint 是 String 接入点 credentialApplySchema 否 CredentialApplySchema object 申请凭证所需数据的Schema 表3 CredentialApplySchema 参数 是否必选 参数类型 描述 type 否 String 类型 name 否 String 名称 description 否 String 描述信息 attributes 否 Array of Attribute objects 属性列表 表4 Attribute 参数 是否必选 参数类型 描述 name 否 String 名称 type 否 String 类型 description 否 String 描述信息

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 peer_num Number peer数量 chaincodes Number 合约数量 block_num Number 区块数量 transaction_num Number 交易数量 bph Array of bph objects 区块产生数量统计，按小时统计 bpm Array of bpm objects 区块产生数量统计，按每5分钟统计 tph Array of tph objects 合约交易数量统计，按小时统计 tpm Array of tpm objects 合约交易数量统计，按每5分钟统计 orgs_map Array of orgs_map objects 组织交易统计 peers_list Array of peers_list objects peer列表 表4 bph 参数 参数类型 描述 block Number 区块数量 time String 时间 表5 bpm 参数 参数类型 描述 block Number 区块数量 time String 时间 表6 tph 参数 参数类型 描述 tx Number 交易数量 time String 时间 表7 tpm 参数 参数类型 描述 tx Number 交易数量 time String 时间 表8 orgs_map 参数 参数类型 描述 org_name String 组织名称 tx_num Number 交易数量 表9 peers_list 参数 参数类型 描述 org_name String 组织名称 org_id String 组织ID peer String Peer名称 url String PeerURL status String Peer状态 状态码： 400 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_message String 错误描述 error_msg String 错误描述

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 channel_id String 通道id block_height Integer 区块高度 transaction_num Integer 交易数量 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_message String 错误描述 error_msg String 错误描述