文档首页/ 数据湖探索 DLI/ API参考（吉隆坡区域）/ SQL作业相关API/ 作业相关API/ 查询作业详细信息
更新时间：2022-12-07 GMT+08:00
查看PDF
分享

查询作业详细信息

功能介绍

该API用于查询作业的详细信息，如作业的databasename、tablename、file size和export mode等信息。

URI

  • URI格式：

    GET/v1.0/{project_id}/jobs/{job_id}/detail

  • 参数说明
    表1 URI 参数

    参数名称

    是否必选

    参数类型

    说明

    project_id

    是

    String

    项目编号，用于资源隔离。获取方式请参考获取项目ID。

    job_id

    是

    String

    作业ID。可通过提交SQL作业（推荐）获取。

请求消息

无请求参数。

响应消息

表2 响应参数

参数名称

是否必选

参数类型

说明

is_success

是

Boolean

执行请求是否成功。“true”表示请求执行成功。

message

是

String

系统提示信息，执行成功时，信息可能为空。

job_id

是

String

作业ID。

owner

是

String

提交作业的用户。

start_time

是

Long

作业开始的时间。是单位为“毫秒”的时间戳。

duration

是

Long

作业执行的时间间隔，单位毫秒。

export_mode

否

String

导出数据或保存查询结果时，指定的导出模式。

范围为“ErrorIfExists”，“Overwrite”。

  • “ErrorIfExists”：存在即报错。指定的导出目录必须不存在，如果指定目录已经存在，系统将返回错误信息，无法执行导出操作。
  • “Overwrite”：覆盖。在指定目录下新建文件，会删除已有文件。

data_path

是

String

导入或导出的文件路径。

data_type

是

String

导入或导出的数据类型（当前支持csv和json格式）。

database_name

是

String

导入或导出表所属的数据库名称。

table_name

是

String

导入或导出表的名称。

with_column_header

否

Boolean

导入作业时，导入的数据是否包括列名。

delimiter

否

String

导入作业时，用户自定义数据分隔符。

quote_char

否

String

导入作业时，用户自定义引用字符。

escape_char

否

String

导入作业时，用户自定义转义字符。

date_format

否

String

导入作业时，指定表的日期格式。

timestamp_format

否

String

导入作业时，指定表的时间格式

compress

否

String

导出作业时，用户指定的压缩方式。

tags

否

Array of objects

作业的标签。具体请参考表3。
表3 tags参数

参数名称

是否必选

参数类型

说明

key

是

String

标签的键。

value

是

String

标签的值。

请求示例

无

响应示例

  • 查询导入作业 
    {
  "is_success": true,
  "message": "",
  "data_path": "obs://DLI/computeCharging/test.csv",
  "data_type": "json",
  "database_name": "iam_exist",
  "date_format": "yyyy-MM-dd",
  "delimiter": ",",
  "duration": 1623,
  "escape_char": "\\",
  "job_id": "a85d7298-ecef-47f9-bb31-499d2099d112",
  "owner": "iam_exist",
  "quote_char": "\"",
  "start_time": 1517385246111,
  "table_name": "DLI_table20",
  "timestamp_format": "yyyy-MM-dd HH:mm:ss",
  "with_column_header": false
}
  • 查询导出作业 
    {
  "is_success": true,
  "message": "",
  "compress": "none",
  "data_path": "obs://xxx/dli/path6",
  "data_type": "json",
  "database_name": "submitjob",
  "duration": 4142,
  "export_mode": "Overwrite",
  "job_id": "b89fccb2-de6a-4c6c-b9b2-21f08a2eb85e",
  "owner": "test",
  "start_time": 1524107798024,
  "table_name": "autotest"
}

状态码

状态码如表4所示。

表4 状态码

状态码

描述

200

查询成功。

400

请求错误。

500

内部服务器错误。

错误码

调用接口出错后，将不会返回上述结果，而是返回错误码和错误信息，更多介绍请参见错误码。

父主题： 作业相关API