
# 创建可视化作业
#### 功能介绍
创建可视化作业。
该接口为异步接口，作业状态请通过[查询可视化作业列表](https://support.huaweicloud.com/api-modelarts/modelarts_03_0065.html)与[查询可视化作业详情](https://support.huaweicloud.com/api-modelarts/modelarts_03_0066.html)接口获取。
#### URI
POST /v1/{project_id}/visualization-jobs
参数说明如[表1]所示。
 表1参数说明 
| 参数         | 是否必选 | 参数类型   | 说明                                                                                               |
|:---|:---|:---|:---|
| project_id | 是    | String | 用户项目ID。获取方法请参见[获取项目ID和名称](https://support.huaweicloud.com/api-modelarts/modelarts_03_0147.html)。 |
   
#### 请求消息
请求参数如[表2]所示。
 表2请求参数 
| 参数        | 是否必选 | 参数类型   | 说明                                                                              |
|:---|:---|:---|:---|
| job_name  | 是    | String | 可视化作业名称。限制为1-20位只含数字，字母，下划线，中划线的名称。                                             |
| job_desc  | 否    | String | 对可视化作业的描述，默认为空，字符串的长度限制为\[0, 256\]。                                             |
| train_url | 是    | String | OBS路径地址。                                                                        |
| job_type  | 否    | String | 可视化的类型，可选的有tensorboard和mindinsight，默认为tensorboard。                              |
| flavor    | 否    | Object | 创建可视化作业选择的规格，用户无需填写。参见[表3]。 |
| schedule  | 否    | Object | 自动停止设置。参见[表4]。               |
   
 表3flavor属性列表 
| 参数   | 是否必选 | 参数类型   | 说明                           |
|:---|:---|:---|:---|
| code | 是    | String | 可视化作业选择的资源规格编码。通过flavor接口获得。 |
   
 表4schedule属性列表 
| 参数        | 是否必选 | 参数类型   | 说明                  |
|:---|:---|:---|:---|
| type      | 是    | String | 设置为stop。            |
| time_unit | 是    | String | 自动停止功能的时间单位 HOURS。  |
| duration  | 是    | Int    | 自动停止，时间范围为\[0,24\]。 |
   
#### 响应消息
响应参数如[表5]所示。
 表5响应参数 
| 参数            | 参数类型    | 说明                                                                                                                                                    |
|:---|:---|:---|
| is_success    | Boolean | 请求是否成功。                                                                                                                                               |
| error_message | String  | 调用失败时的错误信息。 调用成功时无此字段。                                                                                |
| error_code    | String  | 调用失败时的错误码，具体请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。 调用成功时无此字段。 |
| job_id        | Long    | 可视化作业的ID。                                                                                                                                             |
| job_name      | String  | 可视化作业的名称                                                                                                                                              |
| status        | Integer | 可视化作业的运行状态，详细作业状态列表请参见[作业状态参考](https://support.huaweicloud.com/api-modelarts/modelarts_03_0074.html)。                                                 |
| create_time   | Long    | 可视化作业的创建时间，时间戳格式。                                                                                                                                     |
| service_url   | String  | 可视化作业的endpoint。                                                                                                                                       |
   
#### 请求示例
如下以创建名为"visualization-job"，描述为"this is a visualization job"，OBS路径为"/obs/name/"的可视化作业为例。
```
POST  https://endpoint/v1/{project_id}/visualization-jobs
{
    "job_name": "visualization-job",
    "job_desc": "this is a visualization job",
    "train_url": "/obs/name/",
    "job_type": "mindinsight",
    "schedule": [
        {
            "type": "stop",
            "time_unit": "HOURS",
            "duration": 1
        }
    ]
}
```
#### 响应示例
- 成功响应示例
  ```
  {
      "is_success": true,
      "job_id": "10",
      "job_name": "visualization-job",
      "status": "1",
      "create_time": "1524189990635"
  }
  ```
  
- 失败响应示例
  ```
  {
      "is_success": false,
      "error_message": "error message",
      "error_code": "ModelArts.0103"
  }
  ```
  
 
#### 状态码
状态码请参见[表1](https://support.huaweicloud.com/api-modelarts/modelarts_03_0094.html#ZH-CN_TOPIC_0000002334623361__table1450010510213)。
