
# 查询作业文件 - ShowFileInfo
#### 功能介绍
从OBS路径上导入作业前，可以通过此接口查询导入作业文件中是否有作业和脚本。
#### 调试
您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/DGC/doc?api=ShowFileInfo)中调试该接口，支持自动认证鉴权。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-dataartsstudio/abcd.html)。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
 
#### URI
- URI格式 POST /v1/{project_id}/jobs/check-file
  

- 参数说明
  表1URI参数说明 
  | 参数名        | 是否必选 | 参数类型   | 说明                                                                                                    |
  |:---|:---|:---|:---|
  | project_id | 是    | String | 项目编号，获取方法请参见[项目ID和账号ID](https://support.huaweicloud.com/api-dataartsstudio/projectid_accountid.html)。 |
     
  
 
#### 请求参数
表2参数说明 
| 参数名       | 是否必选 | 参数类型   | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|:---|:---|:---|:---|
| path      | 是    | String | 有OBS场景： 作业定义文件在OBS上的路径。例如obs://myBucket/jobs.zip。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| workspace | 否    | String | 工作空间id。获取方法请参见[实例ID和工作空间ID](https://support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0350.html)。 - 如果不设置该参数，默认查询default工作空间下的数据。  - 如果需要查询其他工作空间的数据，需要带上该消息头。 说明： - 多个DataArts Studio实例需要指定工作空间。  - 当工作空间里面没有default工作空间时，工作空间为必填参数，否则会报错。      |
   
#### 响应参数
表3参数说明 
| 参数名     | 是否必选 | 参数类型           | 说明                                                                             |
|:---|:---|:---|:---|
| jobs    | 否    | List\<Job\>    | 作业信息，参考[表4] |
| scripts | 否    | List\<Script\> | 脚本信息，[表5]  |
   
 表4job字段数据结构说明 
| 参数名    | 是否必选 | 参数类型                 | 说明   |
|:---|:---|:---|:---|
| params | 否    | Map\<String,String\> | 作业参数 |
| name   | 是    | String               | 作业名称 |
| path   | 是    | String               | 作业路径 |
   
 表5Script字段数据结构说明 
| 参数名  | 是否必选 | 参数类型   | 说明   |
|:---|:---|:---|:---|
| name | 是    | String | 脚本名称 |
| path | 是    | String | 脚本路径 |
   
#### 请求示例
查询OBS上作业文件中的参数定义。作业定义文件在OBS上的路径为**obs://aaaaa/DLF_myJob.zip** 。
```
POST /v1/b384b9e9ab9b4ee8994c8633aabc9505/jobs/check-file
{
"path": "obs://aaaaa/DLF_myJob.zip"
}
```
#### 响应示例
- 成功响应
  ```
  {
      "jobs":[
          {
              "name":"test",
              "path":"/test",
              "params":{
                  "ddd":"dddd"
              }
          },
          {
              "name":"test1",
              "path":"/test",
              "params":{
                  "ddd":"dddd"
              }
          }
      ],
      "scripts":[
          {
              "name":"script1",
              "path":"/path1"
          },
          {
              "name":"script2",
              "path":"/path1"
          }
      ]
  }
  ```
  

- 失败响应 HTTP状态码 400
  ```
  {
      "error_code":"DLF.20815",
      "error_msg":"Fail to read OBS file."
  }
  ```
  
 
#### 状态码
状态码请参见[状态码](https://support.huaweicloud.com/api-dataartsstudio/dataartsstudio_02_0310.html)。
