文档

GetLiveSnapshotJob - 获取实时截图任务

更新时间:

调用GetLiveSnapshotJob获取单个实时截图任务。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
JobIdstring

任务 ID。

****a046-263c-3560-978a-fb287782****

返回参数

名称类型描述示例值
object

响应数据。

RequestIdstring

请求 ID。

******11-DB8D-4A9A-875B-275798******
JobIdstring

任务 ID。

****a046-263c-3560-978a-fb287782****
JobNamestring

任务名称。

截图任务1
TemplateIdstring

模板 ID。

****a046-263c-3560-978a-fb287666****
TemplateNamestring

模板名称。

模板1
Statusstring

任务状态。

枚举值:
  • init未启动
  • paused已停止
  • started执行中
started
StreamInputobject

输入信息。

Urlstring

输入地址。

rtmp://www.aliyun.com/stream
Typestring

输入类型,目前只支持 rtmp。

rtmp
SnapshotOutputobject

输出信息。

StorageTypestring

存储类型,目前只支持 oss。

oss
Endpointstring

输出终端,type=oss 时返回 OSS 域名。

oss-cn-shanghai.aliyuncs.com
Bucketstring

输出终端的 Bucket,type=oss 时返回 OSS Bucket。

testbucket
OverwriteFormatstring

覆盖截图格式。

snapshot/{JobId}.jpg
SequenceFormatstring

序列截图格式。

snapshot/{JobId}/{UnixTimestamp}.jpg
TimeIntervalinteger

截图时间间隔。

5
CallbackUrlstring

截图回调地址。

http://www.aliyun.com/snapshot/callback
LastModifiedstring

最后修改时间。

2022-02-02T22:22:22Z
CreateTimestring

创建时间。

2022-02-02T22:22:22Z

示例

正常返回示例

JSON格式

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "JobId": "****a046-263c-3560-978a-fb287782****",
  "JobName": "截图任务1",
  "TemplateId": "****a046-263c-3560-978a-fb287666****",
  "TemplateName": "模板1",
  "Status": "started",
  "StreamInput": {
    "Url": "rtmp://www.aliyun.com/stream",
    "Type": "rtmp"
  },
  "SnapshotOutput": {
    "StorageType": "oss",
    "Endpoint": "oss-cn-shanghai.aliyuncs.com",
    "Bucket": "testbucket"
  },
  "OverwriteFormat": "snapshot/{JobId}.jpg",
  "SequenceFormat": "snapshot/{JobId}/{UnixTimestamp}.jpg",
  "TimeInterval": 5,
  "CallbackUrl": "http://www.aliyun.com/snapshot/callback",
  "LastModified": "2022-02-02T22:22:22Z",
  "CreateTime": "2022-02-02T22:22:22Z"
}

错误码

HTTP status code错误码错误信息描述
400MissingParameter%s-
400InvalidParameter%s-
403UserDisableUser is disable.-
403ForbiddenUser not authorized to operate on the specified resource.无权限执行该操作。(一般是由于账号未获得相应权限,参考 账号授权策略。)
403OperationDeniedYour account has not enabled the ICE service.账号未开通智能媒体生产服务。
404JobNotFoundNo such job.-
500InternalErrorThe request processing has failed due to some unknown error.后台发生未知错误,请稍后重试或联系客服解决。

访问错误中心查看更多错误码。

  • 本页导读 (1)