查询数据集列表
功能介绍
查询数据集,支持分页和按条件过滤查询
URI
POST /v1/datashare/query-datasets
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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) |
响应参数
状态码: 200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
items |
Array of DatasetResponse objects |
列表 |
|
pagination |
PaginationResp object |
分页信息 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
加密类型 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
fileType |
String |
文件类型 |
|
dataUrl |
String |
数据url |
|
dataHash |
String |
数据哈希 |
|
dataSize |
String |
数据大小 |
|
dataName |
String |
数据名称 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
currentPage |
Integer |
当前页码 |
|
pageSizeNum |
Integer |
每页条数 |
|
totalItems |
Integer |
总条数 |
状态码: 500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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"
}
响应示例
状态码: 200
数据集分页信息
{
"items" : [ {
"provider" : "did:example:DHkJjyD5wZwya6sd6BNBnG",
"providerName" : "xxx",
"productName" : "prodname2",
"productID" : "product2",
"sampleUrl" : "http://sdcloud.com/sample.com/prodname2",
"sampleSize" : "10KB",
"sampleType" : "csv",
"sampleName" : "data_sub1",
"fileType" : "csv",
"dataUrl" : "http://sdcloud.com/prodname2",
"dataHash" : "2282ba7a1a2ef5700609214a997d3d4237a03bfd3632c6d089e57e7b6f467969",
"dataSize" : "100MB",
"dataName" : "mydata",
"description" : "this is second prod",
"price" : "0",
"encryptedAesKey" : "BA4Ub3t3IskN8uKcEMa+4cbtsDS8OzF4V/qqb4OcPMeMvp7IL+HClzAbL6lPnhbDg/AnrStBlf0qFzRj+qvk6ZH0c7wP0aS48fSoNtecG79aFpFx0dg7rFdVYXWWzgeyI03eD3gFdXlQ/ovpxKJG5ALK39OCazUqDrawZHSDGyIlw0hGh88Q+GVORVSp+6V5Ag==",
"status" : "ready",
"publishTime" : "1607157244",
"dataFiles" : [ {
"fileType" : "csv",
"dataUrl" : "http://sdcloud.com/prodname2",
"dataHash" : "2282ba7a1a2ef5700609214a997d3d4237a03bfd3632c6d089e57e7b6f467969",
"dataSize" : "100MB",
"dataName" : "mydata"
} ],
"sampleFiles" : [ {
"fileType" : "csv",
"dataUrl" : "http://sdcloud.com/prodname2",
"dataHash" : "2282ba7a1a2ef5700609214a997d3d4237a03bfd3632c6d089e57e7b6f467969",
"dataSize" : "100MB",
"dataName" : "mydata"
} ],
"category" : "string"
} ],
"pagination" : {
"currentPage" : 1,
"pageSizeNum" : 100,
"totalItems" : 10
}
}
状态码: 500
失败响应
{
"errorCode" : "BCS.5002046",
"errorMsg" : "Incorrect number of arguments"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
数据集分页信息 |
|
500 |
失败响应 |