更新时间:2021-12-17 GMT+08:00
分享

查询文件字段列表

功能介绍

查询文件的字段列表,用于采集,解析,治理。

URI

  • URI格式
    GET /softcomai/datalake/dataplan/v1.0/debug/file/columns?filePath={filePath}&dsType={dsType}&autoDetectFieldType={autoDetectFieldType}
  • 参数说明

    参数名

    是否必选

    参数类型

    备注

    filePath

    String

    文件路径。

    dsType

    String

    文件类型,OBS和HDFS。

    autoDetectFieldType

    Boolean

    是否自动检查文件字段类型。

请求

  • 请求样例
    GET https://ipaddr:port/softcomai/datalake/dataplan/v1.0/debug/file/columns?filePath=s3a%3A%2F%2Fobs-dataplan%2Fdataplancase%2Fdatapaln_modelA.csv&dsType=OBS&autoDetectFieldType=true
  • 参数说明

    无。

响应

  • 成功响应样例
    {
        "success":true,
        "returnData":{
            "fields":[
                {
                    "name":"start_time",
                    "dataType":"String",
                    "index":0,
                    "length":20
                },
                {
                    "name":"value",
                    "dataType":"Number",
                    "index":1,
                    "length":10
                }
            ],
            "separator":","
        }
    }
  • 要素说明

    参数名

    参数类型

    备注

    success

    String

    请求是否成功,取值包括true和false。

    returnData

    JSON

    返回值。

    fields

    String

    字段信息。

    name

    String

    字段名称。

    dataType

    String

    字段类型。

    index

    String

    索引。

    separator

    String

    分隔符。

状态码

具体请参考状态码

相关文档