
# 关键帧查询 - IGetKeyFrames
#### 功能介绍
关键帧查询
#### 授权信息
当前API调用无需身份策略权限。
#### URI
GET /koodrive/ose/v1/smartvideo/keyframes
表1Query参数 
| 参数     | 是否必选 | 参数类型   | 描述   |
|:---|:---|:---|:---|
| fileId | 是    | String | 文件Id |
   
#### 请求参数
表2请求Header参数 
| 参数            | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                         |
|:---|:---|:---|:---|
| Authorization | 是    | String | 鉴权头                                                                                                                                                                                                        |
| X-Date        | 是    | String | 参数解释：签名时间，用于appId鉴权 约束限制：距当前时间15分钟以内，不能晚于当前时间 取值范围：日期格式，yyyMMdd'T'HHmmss'Z'，例：20251103T070140Z 默认取值：不涉及 |
| X-User-Id     | 是    | String | 用户id，不用于appId鉴权                                                                                                                                                                                            |
| language      | 否    | String | 国际化语言标识，符合i18n规范，如zh-CN表示简体中文，en-US表示美式英语，不传默认美式英语                                                                                                                                                         |
| X-AIUser-Id   | 否    | String | 用户id，用于appId鉴权，与X-User-Id必选其一，都存在时以X-AIUser-Id的值为准                                                                                                                                                         |
   
#### 响应参数
**状态码：200**
表3响应Body参数 
| 参数               | 参数类型                                                                   | 描述    |
|:---|:---|:---|
| keyframeInfoList | Array of [KeyframeInfo] objects | 关键帧响应 |
| code             | String                                                                 | 错误码   |
| msg              | String                                                                 | 错误信息  |
   
 表4KeyframeInfo 
| 参数          | 参数类型   | 描述        |
|:---|:---|:---|
| downloadUrl | String | 关键帧图片下载地址 |
| start       | String | 关键帧开始时间   |
| end         | String | 关键帧结束时间   |
   
**状态码：401**
表5响应Body参数 
| 参数   | 参数类型   | 描述   |
|:---|:---|:---|
| code | String | 状态码  |
| msg  | String | 状态描述 |
   
#### 请求示例
获取视频帧请求示例
```
/koodrive/ose/v1/smartvideo/keyframes?fileId=1101
header:
Authorization:Bearer+5844fbc45a7a249180c292e4bce6fb9e52780a011d53aead
```
#### 响应示例
**状态码：200**
获取视频帧响应体
```
{
  "keyframeInfoList" : [ {
    "start" : 1200,
    "end" : 1331,
    "download" : "https//:obs/xx1/xx2/v1.jpg"
  }, {
    "start" : 1500,
    "end" : 1731,
    "imgPath" : "https//:obs/xx1/xx2/v2.jpg"
  }, {
    "start" : 1800,
    "end" : 1931,
    "imgPath" : "https//:obs/xx1/xx2/v3.jpg"
  } ],
  "code" : 0,
  "msg" : "success"
}
```
#### 状态码
| 状态码 | 描述       |
|:---|:---|
| 200 | 获取视频帧响应体 |
| 401 | 鉴权失效     |
   
