调用ListVideos接口获取媒体集中的视频信息列表,返回结果以视频加入媒体集的时间升序排序。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String ListVideos

操作接口名称,固定取值为ListVideos。

CreateTimeStart String 2021-01-21T06:40:41.683Z

视频创建时间的起始点,返回的视频均在此时间后加入媒体集。

Project String immvideotest

项目名称。

SetId String videotest

媒体集的唯一标识。

RegionId String cn-hangzhou

项目所在地域的ID。

地域Endpoint格式为imm.RegionId.aliyuncs.com,例如当RegionId为cn-hangzhou时,地域Endpoint为imm.cn-hangzhou.aliyuncs.com。

Marker String CAESEgoQCg4KCkNyZWF0ZVRpbWUQABgBItcBCgkAIUv1J88rSRYKyQEDxAAAADFTMzEzNzM0MzYzNDM5MzUzODM1MzczNjMwMzIzNzM0MzUzYTY5NmQ2ZDY5NmQ2MTY3NjUzYTczNjU3NDMwMzAzMTNhMzc2NTY1NjM2NTMyMzQzNjYyMzUzMjM3MzgzODMwMzA2MzM4NjE2NDM4NjQ2MzY2NjE2MTMxNjMzNDMxNjY2MTY0MzEzODM0NjMzOTMzNjQ2MTM2MzUzMjY2NjYzMjMzNjUzNzM1NjUzNzM3MzM2MTY0MzEzMTM2MzYzMTM4Mzk=

从Marker开始按字典序返回视频信息列表。如果不设置此参数,则从头开始返回视频信息。

返回数据

名称 类型 示例值 描述
NextMarker String CAESEgoQCg4KCkNyZWF0ZVRpbWUQABgBItcBCgkAIUv1J88rSRYKyQEDxAAAADFTMzEzNzM0MzYzNDM5MzUzODM1MzczNjMwMzIzNzM0MzUzYTY5NmQ2ZDY5NmQ2MTY3NjUzYTczNjU3NDMwMzAzMTNhMzc2NTY1NjM2NTMyMzQzNjYyMzUzMjM3MzgzODMwMzA2MzM4NjE2NDM4NjQ2MzY2NjE2MTMxNjMzNDMxNjY2MTY0MzEzODM0NjMzOTMzNjQ2MTM2MzUzMjY2NjYzMjMzNjUzNzM1NjUzNzM3MzM2MTY0MzEzMTM2MzYzMTM4Mzk=

下一次列出视频信息时以此值为Marker,将未返回的结果返回。

当视频信息未全部返回时,此参数才有值。

RequestId String B1469D0A-862A-405E-B81B-37760516627D

当次请求的Request ID。

SetId String videoset

媒体集的唯一标识。

Videos Array of Videos

视频信息列表。

CreateTime String 2021-01-21T07:40:41.683Z

视频加入媒体集的时间。

ExternalId String externalId001

外部ID,用于和您的应用层的ID(如果有)进行绑定。

FileSize Integer 25115517

文件大小,单位为字节。

ModifyTime String 2021-01-21T07:40:41.683Z

视频的修改时间。

添加视频到媒体集后,如果未修改过视频,则视频的修改时间和视频加入媒体集的时间相同。

ProcessFailReason String Timeout

视频处理的失败原因。

ProcessModifyTime String 2021-01-21T07:40:53.955Z

视频处理的更新时间。

ProcessStatus String Success

视频处理的状态。

RemarksA String AdminGroup/AdminUserA/

标记信息。

RemarksB String nas://path/to/file

标记信息。

RemarksC String remarkc

标记信息。

RemarksD String remarkd

标记信息。

SourcePosition String 00000000.010

视频中该图片帧处于源视频的时间轴位置。格式为00000000.010,即%8.3f。

SourceType String video

源数据的类型。

SourceUri String oss://imm-test/testcases/video.mp4

视频的OSS URI。

VideoDuration Float 15.263

视频时长,单位为秒。

VideoFormat String mov,mp4,m4a,3gp,3g2,mj2

视频格式。

VideoFrames Integer 462

帧数。

VideoHeight Integer 1920

视频画面的高度。

VideoTags Array of VideoTags

视频标签处理结果。

ParentTagName String 内部场景

父级标签名称。

TagConfidence Float 0.8933850526809692

标签置信度。

TagLevel Integer 2

标签级别,取值范围为1~4。

TagName String 大型超市

标签名称。

VideoTagsFailReason String Timeout

视频标签处理的失败原因。

VideoTagsModifyTime String 2021-01-21T07:40:53.95Z

视频标签处理的更新时间。当VideoTagsStatus更改时更新。

VideoTagsStatus String Success

视频标签处理的状态,包括如下选项:

  • NotProcessed:未处理
  • Processing:处理中
  • Success:成功
  • Failed :失败

您可以根据该状态决定读取结果、等待或重试。

VideoUri String oss://imm-test/testcases/video.mp4

视频的OSS URI。

VideoWidth Integer 1080

视频画面的宽度。

示例

请求示例

http(s)://[Endpoint]/?Action=ListVideos
&CreateTimeStart=2021-01-21T06:40:41.683Z
&Project=immvideotest
&SetId=videotest
&<公共请求参数>

正常返回示例

XML格式

<RequestId>B1469D0A-862A-405E-B81B-37760516627D</RequestId>
<NextMarker/>
<SetId>videoset</SetId>
<Videos>
    <ModifyTime>2021-01-21T07:40:41.683Z</ModifyTime>
    <ProcessStatus>Success</ProcessStatus>
    <VideoWidth>1080</VideoWidth>
    <SourceUri>oss://imm-test/testcases/video.mp4</SourceUri>
    <SourceType>video</SourceType>
    <RemarksA>AdminGroup/AdminUserA/</RemarksA>
    <RemarksB>nas://path/to/file</RemarksB>
    <RemarksC>remarkc</RemarksC>
    <RemarksD>remarkd</RemarksD>
    <VideoHeight>1920</VideoHeight>
    <VideoTagsFailReason>Timeout</VideoTagsFailReason>
    <VideoTagsModifyTime>2021-01-21T07:40:53.95Z</VideoTagsModifyTime>
    <VideoFrames>462</VideoFrames>
    <ProcessModifyTime>2021-01-21T07:40:53.955Z</ProcessModifyTime>
    <ProcessFailReason>Timeout</ProcessFailReason>
    <ExternalId>externalId001</ExternalId>
    <CreateTime>2021-01-21T07:40:41.683Z</CreateTime>
    <VideoUri>oss://imm-test/testcases/video.mp4</VideoUri>
    <VideoFormat>mov,mp4,m4a,3gp,3g2,mj2</VideoFormat>
    <VideoDuration>15.263</VideoDuration>
    <VideoTagsStatus>Success</VideoTagsStatus>
    <FileSize>25115517</FileSize>
    <VideoTags>
        <TagName>内部场景</TagName>
        <TagConfidence>0.9230213165283203</TagConfidence>
        <TagLevel>1</TagLevel>
    </VideoTags>
    <VideoTags>
        <TagName>大型超市</TagName>
        <TagConfidence>0.8933850526809692</TagConfidence>
        <TagLevel>2</TagLevel>
        <ParentTagName>内部场景</ParentTagName>
    </VideoTags>
</Videos>

JSON格式

{
    "RequestId": "B1469D0A-862A-405E-B81B-37760516627D",
    "NextMarker": "",
    "SetId": "videoset",
    "Videos": [
        {
            "ModifyTime": "2021-01-21T07:40:41.683Z",
            "ProcessStatus": "Success",
            "VideoWidth": 1080,
            "SourceUri": "oss://imm-test/testcases/video.mp4",
            "SourceType": "video",
            "RemarksA": "AdminGroup/AdminUserA/",
            "RemarksB": "nas://path/to/file",
            "RemarksC": "remarkc",
            "RemarksD": "remarkd",
            "VideoHeight": 1920,
            "VideoTagsFailReason": "Timeout",
            "VideoTagsModifyTime": "2021-01-21T07:40:53.95Z",
            "VideoFrames": 462,
            "ProcessModifyTime": "2021-01-21T07:40:53.955Z",
            "ProcessFailReason": "Timeout",
            "ExternalId": "externalId001",
            "CreateTime": "2021-01-21T07:40:41.683Z",
            "VideoUri": "oss://imm-test/testcases/video.mp4",
            "VideoFormat": "mov,mp4,m4a,3gp,3g2,mj2",
            "VideoDuration": 15.263,
            "VideoTagsStatus": "Success",
            "FileSize": 25115517,
            "VideoTags": [
				{
					"TagName": "内部场景",
					"TagConfidence": "0.9230213165283203",
					"TagLevel": 1
				},
				{
					"TagName": "大型超市",
					"TagConfidence": "0.8933850526809692",
					"TagLevel": 2,
					"ParentTagName": "内部场景"
				}
			]
        }
    ]
}