调用 TerminateVideoAISummary 接口,终止 AI 视频总结任务。
Status 小于 3 时,可调用本接口终止任务。下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | TerminateVideoAISummary |
接口名称。当前 API 的名称为 TerminateVideoAISummary。 |
| Version | String | 是 | 2023-08-01 |
接口版本。当前 API 的版本为 2023-08-01。 |
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| ActivityId | Long | 是 | 12321*****253 |
直播间 ID 或点播间 ID。获取方式如下: |
| * 您可通过调用 ListActivityAPI 接口获取直播间 ID | ||||
| * 您可通过调用 ListVideoRooms 接口获取点播间 ID | ||||
| :::tip | ||||
| 使用子账号调用接口时,确保该直播间或点播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理。 | ||||
| ::: | ||||
| Vid | String | 是 | v02a49g****tnog65tlutgmtgg |
直播间或点播间中的视频 Vid。获取方式如下: |
* 要获取直播间的视频 Vid,您可通过调用 ListActivityMediaAPI 接口获取视频的 Vid 和视频关联的直播间信息 |
||||
* 要获取点播间的视频 Vid,您可通过调用 ListVideoRoomMedias 接口获取指定点播间视频的 Vid |
| 参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| Status | Boolean | true |
AI 视频总结任务是否成功终止。取值如下: |
* true:任务已被成功终止 |
|||
* false:总结任务已进入总结生成阶段,无法被终止。仅支持终止尚未开始生成 AI 总结内容的任务。您可调用 GetVideoAISummary 接口获取任务状态。当 Status 小于 3 时,可调用本接口终止任务。 |
|||
POST https://livesaas.volcengineapi.com/?Action=TerminateVideoAISummary&Version=2023-08-01
{
"Vid": "v02a49370000br****vm75gbiokkno91",
"ActivityId": 12321*****253
}
{
"ResponseMetadata": {
"RequestId": "20230604110420****100232280022D31",
"Action": "TerminateVideoAISummary",
"Version": "2023-08-01",
"Service": "livesaas",
"Region": "cn-north-1",
"SystemTime": 1697446406
},
"Result": {
"Status": true
}
}