Skip to content

Commit

Permalink
up
Browse files Browse the repository at this point in the history
  • Loading branch information
@fishlyliu
fishlyliu committed Sep 13, 2017
1 parent 4c7b6e5 commit c783d67
Show file tree
Hide file tree
Showing 4 changed files with 80 additions and 97 deletions.
163 changes: 69 additions & 94 deletions product/视频服务/点播/服务端API列表/任务管理/查询任务信息.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,109 +36,20 @@ https://vod.api.qcloud.com/v2/index.php?Action=GetTaskInfo
| code | Integer | 错误码, 0: 成功, 其他值: 失败 |
| message | String | 错误信息 |
| status | String | 任务状态，有PROCESSING和FINISH两种 |
| type | String | 任务类型，目前只支持procedure |
| type | String | 任务类型，目前只支持procedure,transcode |
| data | Object | 任务详细信息，type的值不同，data数据也不相同 |


### type为procedure

| 参数名称 | 类型 | 说明 |
|---------|---------|---------|
| data.metaData | Object | 视频元信息，该字段一定存在，字段信息参见[metaData（视频元信息）](#metadata.EF.BC.88.E8.A7.86.E9.A2.91.E5.85.83.E4.BF.A1.E6.81.AF.EF.BC.89) |
| data.drm | Object | 文件加密信息，用户在发起任务流时在[转码控制参数](https://www.qcloud.com/document/product/266/9642#transcode.EF.BC.88.E8.BD.AC.E7.A0.81.E6.8E.A7.E5.88.B6.E5.8F.82.E6.95.B0.EF.BC.89)指定了加密，该字段才存在。 字段信息参见[drm（视频加密信息）](#drm.EF.BC.88.E8.A7.86.E9.A2.91.E5.8A.A0.E5.AF.86.E4.BF.A1.E6.81.AF.EF.BC.89) |
| data.processTaskList | Array | 任务流包含的任务列表，字段信息参见[processTaskList（任务列表）](#processtasklist.EF.BC.88.E4.BB.BB.E5.8A.A1.E5.88.97.E8.A1.A8.EF.BC.89) |

#### metaData（视频元信息）

| **参数名称** | **类型** | **描述** |
|---------|---------|---------|
| size | Integer | 视频大小。单位：字节 |
| container | String | 容器类型，例如m4a，mp4等 |
| bitrate | Integer | 视频流码率平均值与音频流码率平均值之和。 单位：kbps |
| height | Integer | 视频流高度的最大值。单位：px |
| width | Integer | 视频流宽度的最大值。单位：px |
| md5 | String | 视频的md5值 |
| duration | Integer | 视频时长。单位：秒 |
| videoStreamList | Array | 视频流信息 |
| videoStreamList.bitrate | Integer | 视频流的码率，单位：kbps |
| videoStreamList.height | Integer | 视频流的高度，单位：px |
| videoStreamList.width | Integer | 视频流的宽度，单位：px |
| videoStreamList.codec | String | 视频流的编码格式，例如h264 |
| videoStreamList.fps | Integer | 帧率，单位：hz |
| audioStreamList | Array | 音频流信息 |
| audioStreamList.bitrate | Integer | 音频流的码率。 单位：kbps |
| audioStreamList.samplingRate | Integer | 音频流的采样率。 单位：hz |
| audioStreamList.codec | String | 音频流的编码格式，例如aac |

#### drm（视频加密信息）

| **参数名称** | **类型** | **描述** |
|---------|---------|---------|
| definition | Integer | 加密模板ID |
| keySource | String | KMS的类型，总共三种，分别为 VodBuildInKMS：腾讯云点播内置KMS；QCloudKMS：腾讯云KMS系统（暂不支持）；PrivateKMS：用于自有KMS系统（暂不支持）。 |
| getKeyUrl | String | 获取解密秘钥的URL |
| edkList | Array | 加密后的数据秘钥列表 |

#### processTaskList（任务列表）
任务信息列表，目前有[Trancode（转码任务）](#trancode.EF.BC.88.E8.BD.AC.E7.A0.81.E4.BB.BB.E5.8A.A1.EF.BC.89)，[SampleSnapshot（采样截图任务）](#samplesnapshot.EF.BC.88.E9.87.87.E6.A0.B7.E6.88.AA.E5.9B.BE.E4.BB.BB.E5.8A.A1.EF.BC.89)，[CoverBySnapshot（截图图片作为视频封面任务）](#coverbysnapshot.EF.BC.88.E6.88.AA.E5.9B.BE.E5.9B.BE.E7.89.87.E4.BD.9C.E4.B8.BA.E8.A7.86.E9.A2.91.E5.B0.81.E9.9D.A2.E4.BB.BB.E5.8A.A1.EF.BC.89)。

#### Trancode（转码任务）

| **参数名称** | **类型** | **描述** |
|---------|---------|---------|
| taskType | String | 任务类型，固定为Transcode |
| status | String | 任务状态，有PROCESSING，SUCCESS，FAIL三种 |
| errCode | Integer | 错误码。 0: 成功, 其他值: 失败 |
| message | String | 错误信息 |
| input | Object | 任务的输入信息 |
| input.definition | Integer | 转码模板ID |
| input.watermark | Integer | 是否设置水印，1为设置，0为没设置。 是否设置取决于用户转码配置 |
| output | Object | 任务的输出信息，任务成功时会有该字段，失败则没有 |
| output.url | String | 视频url |
| output.size | Integer | 视频大小。单位：字节 |
| output.container | String | 容器类型，例如m4a，mp4等 |
| output.bitrate | Integer | 视频流码率和音频流码率之和，单位：kbps |
| output.height | Integer | 视频流高度的最大值。单位：px |
| output.width | Integer | 视频流宽度的最大值。单位：px |
| output.md5 | String | 视频的md5值 |
| output.duration | Integer | 视频时长。单位：秒 |
| output.videoStreamList | Array | 视频流信息，元素字段和元信息中videoStreamList相同 |
| output.audioStreamList | Array | 音频流信息，元素字段和元信息中audioStreamList相同 |

#### SampleSnapshot（采样截图任务）

| **参数名称** | **类型** | **描述** |
|---------|---------|---------|
| taskType | String | 任务类型，固定为SampleSnapshot |
| status | String | 任务状态，有PROCESSING，SUCCESS，FAIL三种 |
| errCode | Integer | 错误码。 0: 成功, 其他值: 失败 |
| message | String | 错误信息 |
| input | Object | 任务的输入信息 |
| input.definition | Integer | 采样截图模板ID |
| output | Object | 任务的输出信息，任务成功时会有该字段，失败则没有 |
| output.imageUrls | Array | 字符串数组，生成的截图url列表 |

#### CoverBySnapshot（截图图片作为视频封面任务）

| **参数名称** | **类型** | **描述** |
|---------|---------|---------|
| taskType | String | 任务类型，固定为CoverBySnapshot |
| status | String | 任务状态，有PROCESSING，SUCCESS，FAIL三种 |
| errCode | Integer | 错误码。 0: 成功, 其他值: 失败 |
| message | String | 错误信息 |
| input | Object | 任务的输入信息 |
| input.definition | Integer | 采样截图模板ID |
| input.positionType | String | 截图方式。Time：依照时间点截图；Percent：依照百分比截图 |
| input.position | Integer | 截图位置。对于依照时间点截图，该值表示指定视频第几秒的截图作为封面；对于依照百分比截图，该值表示使用视频百分之多少的截图作为封面 |
| output | Object | 任务的输出信息，任务成功时会有该字段，失败则没有 |
| output.imageUrl | Array | 作为视频封面的截图url |
### data说明
当type为procedure，data内容与[事件通知-任务流状态变更](/document/product/266/9636)回调包体中data字段相同
当type为transcode，data内容与[事件通知-转码完成](/document/product/266/7832)回调包体中data字段相同

### 错误码说明
| 错误码 | 含义说明|
|---------|---------|
| 4000-7000 | 参见公共错误码。 |

### 应答示例
### 应答示例-当任务类型为任务流(procedure)
```
{
"code": "4.0",
Expand Down Expand Up @@ -269,3 +180,67 @@ https://vod.api.qcloud.com/v2/index.php?Action=GetTaskInfo
}
}
```

### 应答示例-当任务类型为转码(transcode)
```
{
"code": "4.0",
"message": "",
"status": "PROCESSING",
"errCode": 0,
"type": "procedure",
"data": {
"status": 0,
"message": "",
"vodTaskId": "Transcode-1edb7eb88a599d05abe451cfc541cfbd",
"fileId": "14508071098244931831",
"fileName": "13425173277_2015-09-06-19-06-11_2015-09-06-19-16-11",
"duration": 599,
"coverUrl": "http://p.qpic.cn/videoyun/0/1203_8a5015084d4f47cd9a0bc5ecfe78aecb_1/640",
"playSet": [
{
"url": "http://vcloud1203.tc.qq.com/1203_8a5015084d4f47cd9a0bc5ecfe78aecb.f0.mp4",
"definition": 0,
"vbitrate": 246000,
"vheight": 480,
"vwidth": 640
},
{
"url": "http://vcloud1203.tc.qq.com/1203_8a5015084d4f47cd9a0bc5ecfe78aecb.f10.mp4",
"definition": 10,
"vbitrate": 149193,
"vheight": 240,
"vwidth": 320
},
{
"url": "http://vcloud1203.tc.qq.com/1203_8a5015084d4f47cd9a0bc5ecfe78aecb.f20.mp4",
"definition": 20,
"vbitrate": 297656,
"vheight": 480,
"vwidth": 640
},
{
"url": "http://vcloud1203.tc.qq.com/1203_8a5015084d4f47cd9a0bc5ecfe78aecb.f220.av.m3u8",
"definition": 220,
"vbitrate": 524288,
"vheight": 480,
"vwidth": 640
},
{
"url": "http://vcloud1203.tc.qq.com/1203_8a5015084d4f47cd9a0bc5ecfe78aecb.f30.mp4",
"definition": 30,
"vbitrate": 899976,
"vheight": 960,
"vwidth": 1280
},
{
"url": "http://vcloud1203.tc.qq.com/1203_8a5015084d4f47cd9a0bc5ecfe78aecb.f40.mp4",
"definition": 40,
"vbitrate": 1746652,
"vheight": 1440,
"vwidth": 1920
}
]
}
}
```
6 changes: 5 additions & 1 deletion product/视频服务/点播/服务端API列表/任务管理/查询任务列表.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ vod.api.qcloud.com
|---------|---------|---------|---------|
| vodTaskId | 是 | String | 任务流ID |
| order | 否 | String | 结果排序，asc：按创建时间升序 desc：按创建时间降序。 不填默认为asc |
| next | 否 | Integer | 从该数据开始查找，如果order是asc，则查找创建时间大于该值的，否则，查找创建时间小于该值的 |
| next | 否 | String | 分批拉取时使用： 当列表比较多时，单次接口调用无法拉取全部列表，这时会返回拉取到的最后一个数据的id，下次请求携带该id，将会从该id下一个开始拉取 |
| startTime | 否 | Integer | 查询创建时间大于该时间的任务，目前任务信息只保存3天，所以该值必须大于三天前的时间戳 |
| endTime | 否 | Integer | 查询创建小于该时间的任务，目前任务信息只保存3天，所以该值必须大于三天前的时间戳 |
| size | 否 | Integer | 查找个数，范围在10-100之间。 不填默认为10 |
Expand All @@ -29,6 +29,10 @@ vod.api.qcloud.com
### 请求示例
```
https://vod.api.qcloud.com/v2/index.php?Action=GetTaskList
&next=59b61160f78939626efd644b
&startTime=1505294672
&endTime=1505295672
&status=Processing
&COMMON_PARAMS
```
## 接口应答
Expand Down
6 changes: 5 additions & 1 deletion product/视频服务/点播/服务端API列表/任务管理/根据FileId查询任务列表.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ vod.api.qcloud.com
|---------|---------|---------|---------|
| fileId | 是 | String | 文件ID |
| order | 否 | String | 结果排序，asc：按创建时间升序 desc：按创建时间降序。 不填默认为asc |
| next | 否 | Integer | 从该数据开始查找，如果order是asc，则查找创建时间大于该值的，否则，查找创建时间小于该值的 |
| next | 否 | String | 分批拉取时使用： 当列表比较多时，单次接口调用无法拉取全部列表，这时会返回拉取到的最后一个数据的id，下次请求携带该id，将会从该id下一个开始拉取 |
| startTime | 否 | Integer | 查询创建时间大于该时间的任务，目前任务信息只保存3天，所以该值必须大于三天前的时间戳 |
| endTime | 否 | Integer | 查询创建小于该时间的任务，目前任务信息只保存3天，所以该值必须大于三天前的时间戳 |
| size | 否 | Integer | 查找个数，范围在10-100之间。 不填默认为10 |
Expand All @@ -30,6 +30,10 @@ vod.api.qcloud.com
```
https://vod.api.qcloud.com/v2/index.php?Action=GetTaskListByFileId
&fileId=9031868223218623494
&next=59b61160f78939626efd644b
&startTime=1505294672
&endTime=1505295672
&status=Processing
&COMMON_PARAMS
```
## 接口应答
Expand Down
2 changes: 1 addition & 1 deletion product/视频服务/点播/服务端API列表/任务管理/重试任务.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ vod.api.qcloud.com

### 请求示例
```
https://vod.api.qcloud.com/v2/index.php?Action=GetTaskList
https://vod.api.qcloud.com/v2/index.php?Action=RetryTask
&COMMON_PARAMS
```
## 接口应答
Expand Down

0 comments on commit c783d67

Please sign in to comment.