华为云用户手册

  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 最小长度:1 最大长度:65535 表3 请求Body参数 参数 是否必选 参数类型 描述 batchCode 是 String 批次码 最小长度:1 最大长度:100 linkName 是 String 环节名称 最小长度:1 最大长度:20 isSweepCodeDisplay 是 String 是否扫码展示:0: 不展示 1: 展示 枚举值: 0 1 merchant 是 String 商户ID 最小长度:1 最大长度:100
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 最小长度:1 最大长度:65535 表3 请求Body参数 参数 是否必选 参数类型 描述 batchCode 是 String 批次码 最小长度:1 最大长度:100 linkName 是 String 环节名称 最小长度:1 最大长度:20 linkSeq 是 Integer 环节顺序 最小值:0 最大值:50 isSweepCodeDisplay 是 String 是否扫码展示:0: 不展示 1: 展示 枚举值: 0 1 isChain 是 Integer 是否上链:0:不上链,1:上链 枚举值: 0 1 inOutType 是 Integer 出入库类型:0:入库;1:出库;2:不涉及出入库 枚举值: 0 1 2 merchant 是 String 商户ID 最小长度:1 最大长度:100
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 code String 返回码 message String 返回描述 data data object 返回数据 表5 data 参数 参数类型 描述 linkCode String 环节码 batchCode String 批次码 merchant String 商户ID 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:100 error_msg String 错误描述 最小长度:1 最大长度:100
  • 响应示例 状态码: 200 Success { "code" : "200", "message" : "操作成功!", "data" : { "linkCode" : "20240220191244787", "batchCode" : "1c403af577ec4b369140c95327b17aed", "merchant" : "1748189792481312769" } } 状态码: 500 Error response { "code" : "500", "message" : "系统异常" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 account Integer 此projectID下的存证总数 最小值:0 最大值:18446744073709551615 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:20 error_msg String 错误描述 最小长度:1 最大长度:512
  • URI GET /v1/{project_id}/evidences/usage 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户从 IAM 申请到的projectid,一般为32位字符串 最小长度:32 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 charge_type 是 String 存证类型, 取值normal,表示普通存证 最小长度:1 最大长度:64
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 name String 存证名称 ev_id String 存证ID file_hash String 文件内容Hash, 即存证指纹 charge_type String 存证类型, normal:普通存证 create_time String 创建时间 tx_id String 交易ID block_hash String 区块哈希 block_height Integer 区块高度 user_addr String 用户地址,基于用户证书生成的公钥 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:20 error_msg String 错误描述 最小长度:1 最大长度:512
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 tx_id String 交易ID, 64位哈希值 最小长度:64 最大长度:64 ev_id String 存证ID 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:20 error_msg String 错误描述 最小长度:1 最大长度:512
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 usages Array of UsageTrendElement objects 使用量趋势 表4 UsageTrendElement 参数 参数类型 描述 t String 时间戳,(UTC时间,毫秒级) v Integer 使用量 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:20 error_msg String 错误描述 最小长度:1 最大长度:512
  • URI GET /v1/{project_id}/evidences/trend 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户从IAM申请到的projectid,一般为32位字符串 最小长度:32 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 charge_type 是 String 存证类型, 取值normal,表示普通存证 最小长度:1 最大长度:64 time_mode 是 String 时间模式,取值支持hour;day;week;month。hour返回30个点,粒度为2分钟;day返回24个点,粒度为1小时;week返回个28点,粒度为6小时;month返回30个点,粒度为1天; 最小长度:3 最大长度:16
  • 响应示例 状态码: 200 Success { "code" : 200, "message" : "操作成功!", "data" : { "batchCode" : "bf2922cda7da4b2cb0a2ef4bb40db7ae", "status" : 2, "parseResult" : { "message" : "Code conflict", "failCount" : 1, "failCodes" : [ { "code" : "6mqqigdk2s" } ] }, "merchant" : 1759540612045058000 } } 状态码: 500 Error response { "code" : "500", "message" : "系统异常" }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 code String 返回码 message String 返回信息 data data object 响应数据 表5 data 参数 参数类型 描述 batchCode String 批次码 status Integer 关联状态,0:处理中 1:处理完成,成功 2:部分失败,有冲突 3:失败 parseResult parseResult object 关联结果 merchant String 商户ID 表6 parseResult 参数 参数类型 描述 message String 关联结果描述 failCount Integer 失败溯源码个数 failCodes Array of failCodes objects 失败溯源码列表 表7 failCodes 参数 参数类型 描述 code String 溯源码 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:100 error_msg String 错误描述 最小长度:1 最大长度:100
  • 响应示例 状态码: 200 Success { "code" : "200", "message" : "操作成功!", "data" : { "id" : "8294ebf8a9a646309985886d63a1bea3", "elementName" : "apple3", "elementUrl" : "https://xxx.xxx.xxx.xxx/petaltrace%2Fimages2.jpeg", "imageType" : "2", "isDisplay" : "0", "merchant" : "1759540612045058049" } } 状态码: 500 Error response { "code" : "500", "message" : "系统异常" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 最小长度:1 最大长度:65535 表3 请求Body参数 参数 是否必选 参数类型 描述 elementName 是 String 图片名称 最小长度:1 最大长度:255 elementUrl 是 String 图片url 最小长度:1 最大长度:255 isDisplay 是 String 是否展示:0 展示,1 不展示 枚举值: 0 1 imageType 是 String 图片类型:1 品宣,2 banner 枚举值: 1 2 merchant 是 String 商户ID,不可修改 最小长度:1 最大长度:100
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 code String 返回码 message String 响应消息 data data object 返回数据 表5 data 参数 参数类型 描述 id String 图片ID elementName String 图片名称 elementUrl String 图片url imageType String 图片类型 isDisplay String 是否展示:0展示,1不展示 merchant String 商户ID 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:100 error_msg String 错误描述 最小长度:1 最大长度:100
  • 请求示例 { "batchCode" : "962cc65f20674ebeb67b765f83bcaa24", "linkCode" : "2024031221062190307601", "linkName" : "清风", "isChain" : "1", "isSweepCodeDisplay" : "1", "inOutType" : 2, "merchant" : "1748189792481312769" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 最小长度:1 最大长度:65535 表3 请求Body参数 参数 是否必选 参数类型 描述 batchCode 是 String 批次码 最小长度:1 最大长度:100 linkCode 是 String 环节码 最小长度:1 最大长度:100 linkName 是 String 环节名称,不可更新 最小长度:1 最大长度:20 isChain 是 String 是否上链:0:不上链, 1:上链 枚举值: 0 1 isSweepCodeDisplay 是 String 是否扫码展示:0: 不展示 1: 展示 枚举值: 0 1 inOutType 是 Integer 出入库类型:0:入库1:出库2:不涉及出入库 枚举值: 0 1 2 merchant 是 String 商户ID 最小长度:1 最大长度:100
  • 响应示例 状态码: 200 verify evidence { "name" : "test01", "ev_id" : "7484b9b5b4bc11ed87c64a2b0e716f7e", "file_hash" : "61135423d6f938fb46932ba2eb2852271e6a3ee20b8c7448e547b96ad72def84", "block_hash" : "rPF6EDUVf+lA1ZoCxPyEPWHO7YiMh+YKATstQqumQV0=", "block_height" : 1556, "create_time" : "1671517527492", "tx_id" : "541443bb866c8af826fcdef85d17a17f0bcc4da6373a32e0c5a8a0da9958f71a", "platform_name" : "test", "data_type" : 1, "user_addr" : "0e4f922e897d977d2c0726ea64ef0852653505f0" } 状态码: 400 Error response { "error_code" : "TDE.40000400", "error_msg" : "InvokeReq params invalid" } { "error_code" : "TDE.40010404", "error_msg" : "resource not found" } 状态码: 500 Error response { "error_code" : "TDE.50010008", "error_msg" : "Internal error" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 name String 存证名称 最小长度:4 最大长度:255 ev_id String 存证ID 最小长度:32 最大长度:64 file_hash String 文件内容Hash, 即存证指纹 最小长度:32 最大长度:64 block_hash String 区块哈希 最小长度:32 最大长度:64 block_height Integer 区块高度 最小值:0 最大值:9223372036854775807 create_time String 创建时间,单位:毫秒 最小长度:13 最大长度:15 tx_id String 交易ID 最小长度:32 最大长度:64 platform_name String 平台名称,用户定义的平台名称 最小长度:0 最大长度:255 data_type Integer 存证的文件类型,0:文件类型1:图片类型2:视频类型3:音频类型4:其他 枚举值: 1 2 3 4 5 user_addr String 用户地址,基于用户证书生成的公钥 最小长度:32 最大长度:64 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:20 error_msg String 错误描述 最小长度:1 最大长度:512 状态码: 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:20 error_msg String 错误描述 最小长度:1 最大长度:512
  • URI GET /v1/{project_id}/chains/{chain_id}/evidence/verification 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户从IAM申请到的projectid,一般为32位字符串 最小长度:32 最大长度:64 chain_id 是 String 数字资产链实例ID 最小长度:32 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 index 否 String 通用搜索条件:取值为存证ID、证据指纹、交易ID中任意1个值 最小长度:32 最大长度:64 file_hash 否 String 证据指纹搜索条件:取值为证据指纹 最小长度:32 最大长度:64 tx_id 否 String 交易ID搜索条件:取值为交易ID 最小长度:32 最大长度:64 ev_id 否 String 存证ID搜索条件:取值为存证ID 最小长度:32 最大长度:64
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 code Integer 返回码 最小值:1 最大值:100 message String 返回描述 最小长度:1 最大长度:100 data Array of data objects 返回批次溯源环节 表5 data 参数 参数类型 描述 batchCode String 批次码 linkCode String 环节码 linkName String 环节名称 最小长度:1 最大长度:20 linkSeq Integer 环节顺序 最小值:0 最大值:50 isSweepCodeDisplay String 是否扫码展示:0: 不展示 1: 展示 isChain String 是否上链:0:不上链,1:上链 枚举值: 0 1 inOutType Integer 出入库类型:0:入库;1:出库;2:不涉及出入库 枚举值: 0 1 2 linkStatus String 环节状态: 0未上链, 1上链中, 2已上链, 3上链失败 枚举值: 0 1 2 3 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:100 error_msg String 错误描述 最小长度:1 最大长度:100
  • 响应示例 状态码: 200 Success { "code" : 200, "message" : "操作成功!", "data" : [ { "batchCode" : "962cc65f20674ebeb67b765f83bcaa24", "linkCode" : "2024031221062190307601", "linkName" : "清风", "linkSeq" : 6, "isSweepCodeDisplay" : "1", "isChain" : "1", "inOutType" : 2, "linkStatus" : "3" } ] } 状态码: 500 Error response { "code" : "500", "message" : "系统异常" }
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 name String 存证名称 ev_id String 存证ID file_hash String 文件内容Hash, 即存证指纹 block_hash String 区块哈希 block_height Integer 区块高度 create_time String 创建时间 tx_id String 交易ID 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:20 error_msg String 错误描述 最小长度:1 最大长度:512
  • URI GET /v1/open/evidences/verification 表1 Query参数 参数 是否必选 参数类型 描述 index 否 String 通用搜索条件:取值为存证ID、证据指纹、交易ID中任意1个值 最小长度:32 最大长度:64 file_hash 否 String 证据指纹搜索条件:取值为证据指纹 最小长度:32 最大长度:64 tx_id 否 String 交易ID搜索条件:取值为交易ID 最小长度:32 最大长度:64 ev_id 否 String 存证ID搜索条件:取值为存证ID 最小长度:32 最大长度:64
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 total_count Integer 总记录 evidences Array of Evidence objects 存证信息列表 表4 Evidence 参数 参数类型 描述 name String 存证名称 ev_id String 存证ID file_hash String 存证指纹 charge_type String 存证类型, normal:普通存证 create_time String 创建时间 tx_id String 交易ID 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:20 error_msg String 错误描述 最小长度:1 最大长度:512
  • URI GET /v1/{project_id}/evidences 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户从IAM申请到的projectid,一般为32位字符串 最小长度:32 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 分页,每页大小,分页大小只支持10、20、50/页,默认显示10条/页 最小值:10 最大值:50 offset 否 Integer 偏移量,从第几项开始,默认值为0 最小值:0 最大值:65535 name 否 String 按照存证名称字段搜索,不支持模糊匹配 最小长度:4 最大长度:765 charge_type 否 String 按照存证类型,精确匹配 最小长度:4 最大长度:64 begin_time 是 String 按照时间范围搜索,起始时间 (UTC时间,毫秒级),和end_time配合使用。最大时间不超过30天。 最小长度:13 最大长度:16 end_time 是 String 按照时间范围搜索,截止时间 (UTC时间,毫秒级),和begin_time配合使用。最大时间不超过30天 最小长度:13 最大长度:16
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 最小长度:1 最大长度:65535 表3 请求Body参数 参数 是否必选 参数类型 描述 merchant 是 String 商户ID 最小长度:1 最大长度:100 query 是 Query object 分页参数 表4 Query 参数 是否必选 参数类型 描述 current 否 Integer 当前页 最小值:1 最大值:2147483647 缺省值:1 size 否 Integer 每页的数量 最小值:1 最大值:2147483647 缺省值:10
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 code String 返回码 最小长度:1 最大长度:50 message String 响应消息 最小长度:1 最大长度:100 data data object 批次列表数据 表6 data 参数 参数类型 描述 pageNum Integer 页数 pageSize Integer 每页数量 total Integer 总数 pages Integer 总页数 record Array of record objects 批次信息 表7 record 参数 参数类型 描述 gmtCreate String 创建时间 gmtModified String 修改时间 productName String 商品名称 最小长度:1 最大长度:100 productCode String 商品码 最小长度:1 最大长度:100 batchCode String 批次码 最小长度:1 最大长度:100 batchName String 批次名称 merchant String 商户ID 最小长度:1 最大长度:100 状态码: 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度:1 最大长度:100 error_msg String 错误描述 最小长度:1 最大长度:100
  • 响应示例 状态码: 200 Success { "code" : 200, "message" : "操作成功!", "data" : { "pageNum" : 1, "pageSize" : 10, "total" : 1, "pages" : 1, "record" : [ { "gmtCreate" : "2022-02-24 01:00:07", "gmtModified" : "2022-02-24 01:00:07", "productName" : "测试", "productCode" : "测试", "batchCode" : "889af5124bfe4e4fbae7cc9aa9b3d786", "batchName" : "批次1", "merchant" : "1748189792481312769" } ] } } 状态码: 500 Error response { "code" : "500", "message" : "系统异常" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token 最小长度:1 最大长度:65535 表3 请求Body参数 参数 是否必选 参数类型 描述 batchCode 是 String 批次码 最小长度:1 最大长度:100 linkName1 是 String 环节名称1 最小长度:1 最大长度:20 linkSeq1 是 Integer 环节顺序1 最小值:0 最大值:50 linkName2 是 String 环节名称2 最小长度:1 最大长度:100 linkSeq2 是 Integer 环节顺序2 最小值:0 最大值:50 merchant 是 String 商户ID 最小长度:1 最大长度:100
共100000条