# 预览SQL作业查询结果 - PreviewSqlJobResult
#### 功能介绍
该API用于在执行SQL查询语句的作业完成后，查看该作业执行的结果。目前仅支持查看"QUERY"类型作业的执行结果。
该API只能查看前1000条的结果记录，且不支持分页查询。若要查看全部的结果记录，需要先导出查询结果再进行查看，详细请参见[导出查询结果 - ExportSqlJobResult](https://support.huaweicloud.com/api-dli/dli_02_0024.html)。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DLI/doc?api=PreviewSqlJobResult)中调试该接口。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限及授权项说明](https://support.huaweicloud.com/api-dli/dli_02_0375.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项 Action | 访问级别 Access Level | 资源类型（\*为必须） Resource Type (\*: required) | 条件键 Condition Key                                                                                                                                                | 别名 Alias | 依赖的授权项 Dependencies |
  |:---|:---|:---|:---|:---|:---|
  | dli:jobs:get                            | read                                            | jobs \*                                                                | - [g:RequestTag/\<tag-key\>](https://support.huaweicloud.com/usermanual-iam5/iam_01_1287.html)   | -                                      | -                                                 |
     
  
 
#### URI
- URI格式： GET /v1.0/{project_id}/jobs/{job_id}/preview
  

- 参数说明
  表1URI 参数 
  | 参数名称       | 是否必选 | 参数类型   | 说明                                                                                     |
  |:---|:---|:---|:---|
  | project_id | 是    | String | 项目编号，用于资源隔离。获取方式请参考[获取项目ID](https://support.huaweicloud.com/api-dli/dli_02_0183.html)。 |
  | job_id     | 是    | String | 作业ID。                                                                                  |
     
  表2query参数 
  | 参数名称       | 是否必选 | 参数类型   | 说明                              |
  |:---|:---|:---|:---|
  | page-size  | 否    | Long   | 结果行数，范围: \[1, 1000\]。默认值为：1000。 |
  | queue-name | 否    | String | 指定获取作业结果的执行队列名称。若不指定则使用默认的系统队列。 |
     
  ![](https://support.huaweicloud.com/api-dli/public_sys-resources/note_3.0-zh-cn.png)
  带入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。可通过[提交SQL作业（推荐） - CreateSqlJob](https://support.huaweicloud.com/api-dli/dli_02_0102.html)获取。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| job_type   | 否    | String           | 作业类型，包含DDL、DCL、IMPORT、EXPORT、QUERY、INSERT、DATA_MIGRATION、UPDATE、DELETE、RESTART_QUEUE、SCALE_QUEUE。 目前仅支持查看"QUERY"类型作业的执行结果。 - DDL：创建修改删除元数据类型的作业  - DCL：权限授权与回收类型的作业 "job_type"为"DCL"时，为同步操作。   - IMPORT：外部数据入库类型的作业  - EXPORT：数据导出到外部类型的作业  - QUERY：运行查询语句类型的作业  - INSERT：向表追加新数据类型的作业  - DATA_MIGRATION：数据迁移作业  - UPDATE：更新表数据的作业  - DELETE：从表中删除数据的作业  - RESTART_QUEUE：重启指定队列的作业  - SCALE_QUEUE：对指定队列扩容/缩容的作业   |
| row_count  | 否    | Integer          | 作业结果总条数。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| input_size | 否    | long             | 作业执行过程中扫描的数据量。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| schema     | 否    | Array of Map     | 作业结果列名称和类型。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| rows       | 否    | Array of Objects | 作业结果集。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
   
#### 请求示例
无
#### 响应示例
```
{
  "is_success": true,
  "message": "",
  "job_id": "ead0b276-8ed4-4eb5-b520-58f1511e7033",
  "job_type": "QUERY",
  "row_count": 1,
  "input_size": 74,
  "schema": [
    {
     "col_name": "c1",
     "data_type": "int",
     "comment": null
   },
   {
     "col_name": "c2",
     "data_type": "string",
     "comment": null
   }
  ],
  "rows": [
    {
      "c1": 23,
      "c2": "sda"
    }
  ]
}
```
#### 状态码
状态码如[表4]所示。
 表4状态码 
| 状态码 | 描述       |
|:---|:---|
| 200 | 查询成功。    |
| 400 | 请求错误。    |
| 500 | 内部服务器错误。 |
   
#### 错误码
调用接口出错后，将不会返回上述结果，而是返回错误码和错误信息，更多介绍请参见[错误码](https://support.huaweicloud.com/api-dli/dli_02_0056.html)。