美文网首页我爱编程
DataApi 接口定义

DataApi 接口定义

作者: 弘弘的小红鸡 | 来源:发表于2017-12-22 17:37 被阅读0次

## 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

}

相关文章

  • DataApi 接口定义

    ## DataApi 接口定义 ### 1. 权限查询 > ##### 请求参数 [ Key ] string-D...

  • PHP接口与抽象类的介绍

    接口 定义接口 通过interface关键字定义接口 使用implements操作符来实现接口 接口定义某个类必须...

  • 接口、抽象类和事件监听机制

    1.接口 1.1接口的定义 定义接口的关键字:interface 定义接口的格式: public interfac...

  • 接口(interface)

    接口的使用 接口使用interface来定义。 Java中,接口和类是并列的结构。 如何定义接口,定义接口中的成员...

  • java萌新入门之事件监听

    1.接口 1.1 接口的定义 定义接口的关键字:interface 格式: public interface 接口...

  • java11(接口与多实现)

    接口: interface 用于定义接口 1 接口中常见定义:常量,抽象方法 2 接口中的...

  • 王兆盟homework4

    定义接口 iTalkable 具有⽅法 talk() 定义接口 iPlayable 具有⽅法 play() 定义抽...

  • retrofit使用

    定义接口 使用接口

  • Kotlin基础(4)-接口

    前言 本文简要介绍一下kotlin中接口的使用 接口的定义 测试结果 Kotlin中的接口定义与Java的接口定义...

  • php_task4

    任务: 定义接口iTalkable 具有⽅法 talk()定义接口 iPlayable具有⽅法 play()定义抽...

网友评论

    本文标题:DataApi 接口定义

    本文链接:https://www.haomeiwen.com/subject/mjsxgxtx.html