调用ListLiveSnapshotFiles获取实时截图文件列表_智能媒体服务(IMS)-阿里云帮助中心

调用ListLiveSnapshotFiles获取实时截图文件列表，可分页获取。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
ice:ListLiveSnapshotFiles		全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
JobId	string	是	截图任务 ID。	**a046-263c-3560-978a-fb287782**
StartTime	string	是	开始时间。UTC 时间，格式：yyyy-MM-ddTHH:mm:ssZ。	2022-02-02T00:00:00Z
EndTime	string	是	结束时间。UTC 时间，格式：yyyy-MM-ddTHH:mm:ssZ。 EndTime 和 StartTime 之间的间隔不能超过 1 天。	2022-02-02T23:59:59Z
Limit	integer	否	每次获取数量，[1, 100]，默认为 10。	10
SortBy	string	否	排序，默认为 asc。枚举值： asc：按时间升序。 desc：按时间倒序。	desc

返回参数

名称	类型	描述	示例值
	object	响应数据。
RequestId	string	请求 ID。	****11-DB8D-4A9A-875B-275798****
FileList	array<object>	文件列表。
Snapshot	object
OssEndpoint	string	OSS 域名。	oss-cn-shanghai.aliyuncs.com
OssBucket	string	OSS bucket。	testbucket
OssObject	string	OSS 存储对象位置。	snapshot/**a046-263c-3560-978a-fb287782**/1660638613798.jpg
CreateTime	string	创建时间。	2022-02-02T22:22:22Z
CreateTimestamp	long	创建时间戳，用于删除接口传参。	1619503516000
IsOverlay	boolean	是否覆盖截图。	true
NextStartTime	string	下一页的开始时间，没有返回则表示结束翻页。	2022-02-02T22:22:22Z

示例

正常返回示例

JSON格式

{
  "RequestId": "******11-DB8D-4A9A-875B-275798******",
  "FileList": [
    {
      "OssEndpoint": "oss-cn-shanghai.aliyuncs.com",
      "OssBucket": "testbucket",
      "OssObject": "snapshot/****a046-263c-3560-978a-fb287782****/1660638613798.jpg",
      "CreateTime": "2022-02-02T22:22:22Z",
      "CreateTimestamp": 1619503516000,
      "IsOverlay": true
    }
  ],
  "NextStartTime": "2022-02-02T22:22:22Z"
}

错误码

HTTP status code	错误码	错误信息	描述
400	MissingParameter	%s	-
400	InvalidParameter	%s	-
400	MalformedStartTime	Specified parameter StartTime is not valid.	-
400	MalformedEndTime	Specified parameter EndTime is not valid.	-
400	EndTimeMismatch	Specified end time does not math the specified start time.	-
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.	-
404	NoValidSnapshot	No snapshots found with given parameters.	-
500	InternalError	The request processing has failed due to some unknown error.	后台发生未知错误，请稍后重试或联系客服解决。

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