调用SubmitLiveSnapshotJob提交实时截图任务。如果在推流中提交,则会自动异步启动任务,否则为未启动状态。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ice:SubmitLiveSnapshotJob |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| JobName |
string |
是 |
任务名称。
|
Screenshot task1 |
| StreamInput |
object |
是 |
流输入信息。 |
|
| Url |
string |
是 |
流输入地址。
|
rtmp://www.aliyun.com/stream |
| Type |
string |
是 |
流输入类型。目前只支持 rtmp。 枚举值:
|
rtmp |
| SnapshotOutput |
object |
是 |
截图输出信息。 |
|
| StorageType |
string |
是 |
截图存储类型。目前只支持 oss。 枚举值:
|
oss |
| Endpoint |
string |
是 |
截图输出终端。 |
oss-cn-shanghai.aliyuncs.com |
| Bucket |
string |
是 |
截图输出终端的 Bucket。 |
testbucket |
| TemplateId |
string |
是 |
模板 ID。 |
****a046-263c-3560-978a-fb287782**** |
| CallbackUrl |
string |
否 |
截图回调地址。
|
http://www.aliyun.com/snapshot/callback |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
响应数据。 |
||
| RequestId |
string |
请求 ID。 |
******11-DB8D-4A9A-875B-275798****** |
| JobId |
string |
任务 ID。 |
****a046-263c-3560-978a-fb287666**** |
示例
正常返回示例
JSON格式
{
"RequestId": "******11-DB8D-4A9A-875B-275798******",
"JobId": "****a046-263c-3560-978a-fb287666****"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | MissingParameter | %s | |
| 400 | InvalidParameter | %s | |
| 500 | InternalError | The request processing has failed due to some unknown error. | |
| 403 | UserDisable | User is disable. | |
| 403 | Forbidden | User not authorized to operate on the specified resource. | |
| 403 | OperationDenied | Your account has not enabled the ICE service. | |
| 404 | TemplateNotFound | No such template. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。