查询数据源数据

路径 /data/datasource/data/query
版本号 1.0.1
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权
超时时间 15000

请求参数

名称 类型 是否必选 示例值 描述
id Long 123 数据源ID,id或name必须填一个
name String datasource_01 数据源标识,id或name必须填一个
expr Struct {"op":"and","condition":[{"col":"deviceId","op":"eq","value":"foo"},{"col":"productKey","op":"neq","value":"zoo"}]} 条件表达式,op支持and/or,op支持AND与,OR或,EQ等于,NEQ不等于,LT小于,GT大于,LE小于等于,GE大于等于,IN,NOT-IN
nodes List [{"name":"deviceId"},{"name":"productKey"},{"name":"date"}] 需要查询的数据节点名称
name String 节点标识符
page Struct {"to":1,"size":15} 分页信息size:分页大小,to,第几个页面,从1开始
orderBy List [{"col":"id","type":"asc"}] 排序的依据
col String
type String
appId String 共享应用的AppID

返回数据

名称 类型 示例值 描述
code Int

响应码, 200: 成功

message String

错误消息

localizedMsg String

本地语言错误消息

data JSON

数据源数据查询返回结果

nodes JSON

执行本次数据查询的数据节点列表

data String

数据源查询返回的数据列表,列表为转化为JSON字符串的JSON数组,使用时需要重新转化为JSON数组。

page JSON

查询结果分页信息

size Int

当前分页的data数据项数目

to Int

当前分页页索引,索引值从1开始递增

total Long

符合查询条件的数据项总数

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.1"
	},
	"params":{
		"id":123,
		"name": "datasource_01",
		"expr":{
			"op": "and",
			"condition":[
				{
					"col": "deviceId",
					"op": "eq",
					"value": "foo"
				},
				{
					"col": "productKey",
					"op": "neq",
					"value": "zoo"
				}
			]
		},
		"nodes":[
			{
				"name": "deviceId"
			},
			{
				"name": "productKey"
			},
			{
				"name": "date"
			}
		],
		"page":{
			"to":1,
			"size":15
		},
		"orderBy":[
			{
				"col": "id",
				"type": "asc"
			}
		],
		"appId": "value6"
	}
}

正常返回示例

JSON 格式

{
  "id": "bee89dbe260e4059b001c1073cb326f4",
  "code": 200,
  "message": null,
  "localizedMsg": null,
  "data": {
    "nodes": ["date", "total", "sold", "carry_rate", "factory", "shift", "operator"],
    "data": "[[\"2019-05-01 00:00:00\",\"10\",\"10\",\"100\",\"淘宝A工厂\",\"早\",\"AAA\"],[\"2019-05-02 00:00:00\",\"10\",\"10\",\"100\",\"淘宝A工厂\",\"早\",\"AAA\"]]",
    "page": {
      "to": 3,
      "size": 15,
      "total": 35
    }
  }
}

异常返回示例

JSON 格式

{
  "id": "f21139f98c2340dc95c1520aa7529eb5",
  "code": 600208,
  "message": "datasource 167198 not found",
  "localizedMsg": "数据源167198不存在",
  "data": null
}

错误码

HttpCode 错误码 错误信息 描述
500 500 Internal Error Internal Error
503 503 Service Unavailable Service Unavailable
403 403 Request Limited Request Limited
401 401 Empty Signature Empty Signature
400 400 Request Format Error Request Format Error
200 20003 Find Backend Error Find Backend Error
200 20004 Backend Service Error Backend Service Error
200 20055 Backend Service Invalid Request Format Error
200 20056 Hsf Invoke Timeout Hsf Invoke Timeout
200 401 Request Authorized Error Request Authorized Error
200 403 Request Forbidden Request Forbidden
200 500 Server Error Server Error