更新时间:2022-04-16 GMT+08:00
分享

预览SQL作业查询结果

功能介绍

该API用于在执行SQL查询语句的作业完成后,查看该作业执行的结果。目前仅支持查看“QUERY”类型作业的执行结果。

该API只能查看前1000条的结果记录,且不支持分页查询。若要查看全部的结果记录,需要先导出查询结果再进行查看,详细请参见导出查询结果

调试

您可以在API Explorer中调试该接口。

URI

  • URI格式:

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

  • 参数说明
    表1 URI 参数

    参数名称

    是否必选

    参数类型

    说明

    project_id

    String

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

    job_id

    String

    作业ID。

    表2 query参数

    参数名称

    是否必选

    参数类型

    说明

    page-size

    Long

    结果行数,范围: [1, 1000]。默认值为:1000。

    queue-name

    String

    指定获取作业结果的执行队列名称。若不指定则使用默认的系统队列。

    带入query参数的URL示例如下:

    GET /v1.0/{project_id}/jobs/{job_id}/preview?page-size={size}&queue-name={queue_name}

请求消息

无请求参数。

响应消息

表3 响应参数

参数名称

是否必选

参数类型

说明

is_success

Boolean

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

message

String

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

job_id

String

作业ID。

job_type

String

作业类型,包含DDL、DCL、IMPORT、EXPORT、QUERY、INSERT、DATA_MIGRATION、UPDATE、DELETE、RESTART_QUEUE、SCALE_QUEUE。

目前仅支持查看“QUERY”类型作业的执行结果。

row_count

Integer

作业结果总条数。

input_size

long

作业执行过程中扫描的数据量。

schema

Array of Objects

作业结果列名称和类型。

rows

Array of Strings

作业结果集。

示例

  • 请求样例:
    None
  • 成功响应样例:
    {
      "is_success": true,
      "message": "",
      "job_id": "ead0b276-8ed4-4eb5-b520-58f1511e7033",
      "job_type": "QUERY",
      "row_count": 1,
      "input_size": 74,
      "schema": [
        {
          "c1": "int"
        },
        {
          "c2": "string"
        }
      ],
      "rows": [
        [
          23,
          "sda"
        ]
      ]
    }

状态码

状态码如表4所示。

表4 状态码

状态码

描述

200

查询成功。

400

请求错误。

500

内部服务器错误。

错误码

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

分享:

    相关文档

    相关产品

close