GetLiveSnapshotJob - 获取实时截图任务 - 智能媒体服务

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

调试

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

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ice:GetLiveSnapshotJob

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
JobId	string	是	任务 ID。	**a046-263c-3560-978a-fb287782**

返回参数

名称	类型	描述	示例值
	object	响应数据。
RequestId	string	请求 ID。	****11-DB8D-4A9A-875B-275798****
JobId	string	任务 ID。	**a046-263c-3560-978a-fb287782**
JobName	string	任务名称。	截图任务1
TemplateId	string	模板 ID。	**a046-263c-3560-978a-fb287666**
TemplateName	string	模板名称。	模板1
Status	string	任务状态。枚举值： init : 未启动 paused : 已停止 started : 执行中	started
StreamInput	object	输入信息。
Url	string	输入地址。	rtmp://www.aliyun.com/stream
Type	string	输入类型，目前只支持 rtmp。枚举值： rtmp : rtmp	rtmp
SnapshotOutput	object	输出信息。
StorageType	string	存储类型，目前只支持 oss。枚举值： oss : oss	oss
Endpoint	string	输出终端，type=oss 时返回 OSS 域名。	oss-cn-shanghai.aliyuncs.com
Bucket	string	输出终端的 Bucket，type=oss 时返回 OSS Bucket。	testbucket
OverwriteFormat	string	覆盖截图格式。	snapshot/{JobId}.jpg
SequenceFormat	string	序列截图格式。	snapshot/{JobId}/{UnixTimestamp}.jpg
TimeInterval	integer	截图时间间隔。	5
CallbackUrl	string	截图回调地址。	http://www.aliyun.com/snapshot/callback
LastModified	string	最后修改时间。	2022-02-02T22:22:22Z
CreateTime	string	创建时间。	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	错误码	错误信息
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	JobNotFound	No such job.

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

变更历史

更多信息，参考变更详情。