文档首页/ 区块链服务 BCS/ 开发指南/ Hyperledger Fabric增强版管理/ 区块链中间件接口/ 可信数据交换（公测）/ 数据订单管理/ 查询订单列表
更新时间：2024-06-28 GMT+08:00
查看PDF
分享

查询订单列表

功能介绍

查询订单，支持分页和按条件过滤查询。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v1/datashare/dataset/query-orders

请求参数

表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

错误描述

请求示例

{
  "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"
}

状态码

状态码

描述

200

订单分页信息

500

失败响应

错误码

请参见错误码。

父主题： 数据订单管理

相关文档