8.2.2 数据下载

创建于 2022-10-21 / 最近更新于 2022-12-15 / 1987

字体： [默认] [大] [更大]

支持通过API获取数据集中的数据，并支持自定义查询SQL语句。

1.单数据集查询

接口定义

请求方式：POST

请求URL：$home_url/universe/public-api/dataset/{id}/query

home_url需要填入对应环境的IP/域名，eg: http://u.guandata.com

Name	Location	类型	含义	必填	备注
Content-Type	Header	String	内容类型	是	application/json;charset=utf-8
token	Header	String	登录用的Token	是	调用登录校验API获取（8.1 登录校验）
id	请求URL	Int	数据集ID	是	需要获取数据的单数据集ID， ID获取方式：9.1 外部系统集成常见问题
sql	Body	String	表查询语句	否	用来获取指定数据集数据的查询语句（必须以select开始，通过input指代单个数据集）。该字段缺省情况下，获得数据即全部数据。

返回参数：

Name	类型	含义	返回条件	备注
columns	Json	本次请求下载的数据集各个列	运行成功	name:列名， type:字段类型
preview	Json	本次请求下载的数据集各行数据详情	运行成功

2.多数据集查询

接口定义

请求方式 POST

请求URL：$home_url/universe/public-api/dataset/multiple-query

home_url需要填入对应环境的IP/域名，eg: http://u.guandata.com

请求参数

Name	Location	类型	含义	必填	备注
Content-Type	Header	String	内容类型	是	application/json;charset=utf-8
token	Header	String	登录用的Token	是	调用登录校验API获取（8.1 登录校验）
tables	Body	String	数据集ID	是	多数据集查询时，指定多个数据集ID， eg：{ "input1":123, "input2":456}， ID获取方式：9.1 外部系统集成常见问题
sql	Body	String	表查询语句	是	用来获取指定数据集数据的查询语句（必须以select开始，通过input1/input2等指代多个数据集）。

返回参数：

Name	类型	含义	返回条件	备注
columns	Json	本次请求下载的数据集各个列	运行成功	name:列名， type:字段类型
preview	Json	本次请求下载的数据集各行数据详情	运行成功

接口调用示例

Header 示例

{
    "Content-Type": "application/json; charset=utf-8",
    "token": "ab7f1665-8dfc-4d8f-928d-c7a5aefc9332"  /*登录校验接口获得的Token（参考8.1）*/
}

POST Body 示例

单数据集查询：

{
    "sql":"select * from input where `售价`<80" /* SQL查询语句*/
}

多数据集查询：

{
    "tables": "{\"input1\":123, \"input2\":456 }", /* 指定数据集ID*/
    "sql":"select input1.shopId, input1.revenue, input2.shopName from input1 left join input2 on input2.shopId=input1.shopId " /* SQL查询语句*/
}

Response

//获取数据成功
{
    "code":0,
    "msg":"success",
    "data":{
        "columns":[
            {
                "name":"流水号",
                "type":"LONG"
            },
            {
                "name":"商品编码",
                "type":"LONG"
            },
            {
                "name":"商品名称",
                "type":"STRING"
            },
            {
                "name":"小类",
                "type":"STRING"
            },
            {
                "name":"大类",
                "type":"STRING"
            },
            {
                "name":"销售日期",
                "type":"DATE"
            },
            {    
                "name":"售价",
                "type":"DOUBLE"
            }
        ],
        "preview":[
            [
                "100001",
                "1234",
                "雀巢咖啡",
                "咖啡",
                "饮料",
                "2020-10-10",
                "88.8"
            ]
        ]
    }
}

//获取数据失败
{
    "code": 110013,  /*错误代码*/
    "msg": "SQL查询数据集失败",  /*失败错误信息*/
}

2 人点赞过