预览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}

请求消息

无请求参数。

响应消息

请求示例

无

响应示例

{
  "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所示。

错误码

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