DataApi 接口定义

## DataApi 接口定义

### 1. 权限查询

> ##### 请求参数

[ Token ] string  -  权限凭证

[ Key ] string  -  DataApi 接口唯一标识

> ##### 返回结果

[ StatusCode ] int  -  接口状态:200 成功, 500 失败

[ Message ] string  -  查询异常消息(可能抛出 Key 不存在、 Token 非法、 系统异常消息)

[ Data ] object  -  返回内容实体

[ IsAuthenticated ] int  -  是否授权状态:0 未授权, 1 已授权, 2 已过期


### 2. 版本可用查询

> ##### 请求参数

[ Key ] string  -  DataApi 接口唯一标识

[ Version ] int  -  DataApi 接口版本号

> ##### 返回结果

[ StatusCode ] int  -  接口状态:200 成功, 500 失败

[ Message ] string  -  查询异常消息(可能抛出 Key 不存在、 Version 号不存在、 系统异常消息)

[ Data ] object  -  返回内容实体

[ IsEnabled ] int  -  是否可用状态:0 不可用, 1 可用


### 3. 获取配置规则内容

> ##### 请求参数

[ Key ] string  -  DataApi 接口唯一标识

[ Version ] int  -  DataApi 接口版本号

> ##### 返回结果

[ StatusCode ] int  -  接口状态:200 成功, 500 失败

[ Message ] string  -  查询异常消息(可能抛出 Key 不存在、 Version 号不存在、 当前 Key + Version 号不可用)

[ Data ] object  -  返回内容实体

[ DriveType ] int  -  驱动类型:0: MsSql(预留), 1 HBase, 2 ElasticSearch, 3 MongoDB, 4 MySql, 5 Presto, 6 Kudu

[ Version ] int  -  接口版本号

[ QueryParam ] list  -  查询可用参数

{

[ QueryParamName ] string  -  参数名

[ QueryParamType ] int  -  参数类型: 0 文本, 1 数字, 2 小数, 3 日期, 4 日期 + 时间, 5 文本数组, 6 数字数组

[ QueryParamRequired ] int  -  参数是否必传: 0 非必传, 1 必传

}

[ QueryBody ] string  -  查询脚本

[ QueryColumn ] string  -  查询结果头信息(非结构查询引擎返回[])

{

[ QueryColumnName ] string  -  字段名

[ QueryColumnType ] int  -  参数类型: 0 string(包含日期字符串), 1 int, 2 double, 3 bool

}

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 135,168评论 19 139
  • 1. Java基础部分 基础部分的顺序:基本语法,类相关的语法,内部类的语法,继承相关的语法,异常的语法,线程的语...
    子非鱼_t_阅读 31,806评论 18 399
  • 一、基本数据类型 注释 单行注释:// 区域注释:/* */ 文档注释:/** */ 数值 对于byte类型而言...
    龙猫小爷阅读 4,296评论 0 16
  • JAVA面试题 1、作用域public,private,protected,以及不写时的区别答:区别如下:作用域 ...
    JA尐白阅读 1,193评论 1 0
  • 经常听说这样的故事,平时自觉身体健康的某个人,忽然在某次例行体检中,检查出了大问题。而且,这样的故事还不少。 但是...
    七七追剧站阅读 527评论 0 2