调用SubmitLiveSnapshotJob提交实时截图任务。如果在推流中提交,则会自动异步启动任务,否则为未启动状态。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
ice:SubmitLiveSnapshotJob |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
JobName | string | 是 | 任务名称。
| 截图任务1 |
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 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "******11-DB8D-4A9A-875B-275798******",
"JobId": "****a046-263c-3560-978a-fb287666****"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | MissingParameter | %s | - |
400 | InvalidParameter | %s | - |
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. | - |
500 | InternalError | The request processing has failed due to some unknown error. | 后台发生未知错误,请稍后重试或联系客服解决。 |
访问错误中心查看更多错误码。