# 生成PDF报告 - PutPdfJob
#### 功能介绍
创建一个生成PDF的异步任务。
#### 调用方法
请参见[如何调用API](https://support.huaweicloud.com/api-codecheck/codecheck_03_0006.html)。
#### 授权信息
账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-codecheck/Permission.html)。
| 授权项                          | 访问级别 | 资源类型（\*为必须） | 条件键                     | 别名 | 依赖的授权项 |
|:---|:---|:---|:---|:---|:---|
| codeartscheck:task:getReport | Read | task \*     | -                       | -  | -      |
| codeartscheck:task:getReport | Read | -           | codeartscheck:ProjectId | -  | -      |
   
#### URI
PUT /v1/tasks/{task_id}/pdf-async-job
表1路径参数 
| 参数      | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                             |
|:---|:---|:---|:---|
| task_id | 是    | String | **参数解释：** 任务ID，即新建检查任务接口的返回值，每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即[查询任务列表](https://support.huaweicloud.com/api-codecheck/ShowTasksList.html)接口响应中的id字段。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~32\]个字符。 **默认取值：** 不涉及。 |
   
表2Query参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                        |
|:---|:---|:---|:---|
| project_name | 是    | String | **参数解释：** PDF报告标题名称。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~128\]个字符。 **默认取值：** 不涉及。 |
   
#### 请求参数
表3请求Header参数 
| 参数         | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
|:---|:---|:---|:---|
| X-Language | 否    | String | **参数解释：** 语言，决定响应以哪种语言返回。 **约束限制：** 不涉及。 **取值范围：** - zh-cn：中文。   - en-us：英文。    **默认取值：** zh-cn。 |
   
#### 响应参数
**状态码：200**
表4响应Body参数 
| 参数     | 参数类型                                         | 描述                                                                                                                                                                                                                                                                                                                                                                                             |
|:---|:---|:---|
| status | String                                       | **参数解释：** 响应状态。 **取值范围：** - success：成功。   - error：失败。    |
| result | [result] object | **参数解释：** 生成PDF报告结果。                                                                                                                                                                                                                                                                                                                                              |
   
 表5result 
| 参数         | 参数类型    | 描述                                                                                                                           |
|:---|:---|:---|
| timeAsk    | Integer | **参数解释：** 建议轮询间隔，单位为秒。 **取值范围：** 不涉及。 |
| asyncJobId | Integer | **参数解释：** 异步任务ID。 **取值范围：** 不涉及。      |
   
**状态码：400**
表6响应Body参数 
| 参数         | 参数类型   | 描述                                                                                                                    |
|:---|:---|:---|
| error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。  |
| error_msg  | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 |
   
**状态码：401**
表7响应Body参数 
| 参数         | 参数类型   | 描述                                                                                                                    |
|:---|:---|:---|
| error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。  |
| error_msg  | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 |
   
#### 请求示例
对于ID为897acf5exxx48a5013cd的任务最新一次版本级扫描生成PDF报告，创建一个生成PDF的异步任务，PDF报告的标题中任务名为test_task。
```
PUT https://{endpoint}/v1/tasks/897acf5exxx48a5013cd/pdf-job?project_name=test_task
```
#### 响应示例
**状态码：200**
请求成功!
```
{
  "status" : "success",
  "error" : null,
  "result" : {
    "timeAsk" : 3,
    "asyncJobId" : 569151
  }
}
```
**状态码：400**
请求异常。
```
{
  "error_code" : "CC.xxxxxxxx.400",
  "error_msg" : "请求参数校验失败,请检查请求参数是否正确"
}
```
**状态码：401**
权限不足。
```
{
  "error_code" : "CC.00000003",
  "error_msg" : "认证信息过期"
}
```
#### 状态码
| 状态码 | 描述    |
|:---|:---|
| 200 | 请求成功! |
| 400 | 请求异常。 |
| 401 | 权限不足。 |
   
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-codecheck/ErrorCode.html)。