文档

QueryMediaList - 查询媒体列表

更新时间:

使用媒体ID查询媒体。

接口说明

本接口一次最多查询 10 个媒体文件。

QPS 限制

本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见 QPS 限制

调试

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

授权信息

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

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

请求参数

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

需要查询的媒体文件 ID 列表,可以登录 MPS 控制台,通过媒体管理 > 媒体列表获取。用半角逗号(,)分隔,一次最多查询 10 个。

3e1cd21131a94525be55acf65888****,e26cfa29e784402388463f61dbec****
IncludePlayListboolean

返回结果中是否包含播放信息。

  • 取值:true(是)、false(否)。

  • 默认值:false

true
IncludeSnapshotListboolean

返回结果中是否包含截图信息。

  • 取值:true(是)、false(否)。

  • 默认值:false

true
IncludeMediaInfoboolean

返回结果中是否包含媒体信息。

  • 取值:true(是)、false(否)。

  • 默认值:false

true
IncludeSummaryListboolean

返回结果中是否包含摘要。

  • 取值:true(是)、false(否)。

  • 默认值:false

true

返回参数

名称类型描述示例值
object

返回参数。

NonExistMediaIdsarray

不存在的媒体 ID 列表。

MediaIdstring

不存在的媒体 ID。无数据时此参数不返回。

{"MediaId":[e26cfa29e784402388463f61dbec****]}
MediaListarray<object>

媒体列表。

Mediaobject

媒体文件详细信息。

CreationTimestring

创建时间。

2016-09-14T08:30:33Z
CateIdlong

类目 ID。

1
Heightstring

媒体文件高。

1080
CensorStatestring

视频审核状态。取值:

  • Initiated:初始(上传成功审核未完成)。

  • Pass:通过(上传成功审核已通过)。

Initiated
Tagsarray

标签信息。

Tagstring

标签列表。

tag1,tag2
PlayListarray<object>

播放列表。

Playobject

播放文件详细信息。

Encryptionstring

加密。取值:

  • 0:未加密。

  • 1:已加密。

0
Heightstring

高。

1080
Bitratestring

码率。

2659.326
Fileobject

播放文件。

Statestring

文件状态。取值:

  • Normal:正常。

  • Deleted:已删除。

Normal
URLstring

输出文件的 OSS Bucket。

http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4
MediaWorkflowIdstring

产生播放文件的工作流 ID。

93ab850b4f6f44eab54b6e91d24d****
Widthstring

媒体文件宽。

760
Sizestring

文件大小。

2647692
Fpsstring

帧率。

25.0
Durationstring

时长。

7.965000
ActivityNamestring

媒体工作流活动名称。

example-activity-****
Formatstring

编码格式。支持 mov、mp4、m4a、3gp、3g2、mj2。

mp4
MediaWorkflowNamestring

产生播放文件的工作流。

example-mediaworkflow-****
Bitratestring

码率。

2659.326
MediaIdstring

媒体 ID。

3e1cd21131a94525be55acf65888****
Fileobject

输入文件详细信息。

Statestring

状态。取值:

  • Normal:正常。

  • Deleted:已删除。

Normal
URLstring

输入文件的 OSS Bucket。

http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4
SummaryListarray<object>

视频摘要列表。

Summaryobject

视频摘要数据。

Typestring

摘要类型。取值:

  • Video:视频类型。
  • Gif:动态图像类型。
Video
MediaWorkflowIdstring

产生摘要的工作流 ID。

93ab850b4f6f44eab54b6e91d24d****
ActivityNamestring

媒体工作流活动名称。

example-activity-****
MediaWorkflowNamestring

产生摘要的工作流名称。

example-mediaworkflow-****
Fileobject

输入文件信息。

Statestring

文件状态。范围:

  • Normal:正常。

  • Deleted:已删除。

Normal
URLstring

输入文件的 OSS Bucket。

http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4
PublishStatestring

媒体发布状态,表示是否对外发布媒体。取值:

  • Initiated:初始。
  • UnPublish:未发布,OSS 播放文件权限为 Private。
  • Published:已发布,OSS 播放文件权限为 Default。
  • Deleted:已删除。
Published
MediaInfoobject

媒体信息。

Streamsobject

流信息。

VideoStreamListarray<object>

视频流列表。

VideoStreamobject

视频流数据。

Sarstring

编码信号分辨率比。

1:1
Heightstring

视频分辨率高。

1080
CodecTagStringstring

编码格式标记文本。

avc1
NetworkCostobject

网络带宽消耗。

PreloadTimestring

预加载时间。

0.01
AvgBitratestring

平均码率。

2659.326
CostBandwidthstring

最大消耗带宽。

100
Widthstring

视频分辨率宽。

100
Indexstring

视频流序号。标识视频流在整个媒体流中的位置。

5
Timebasestring

时基。

1/30000
AvgFPSstring

平均帧率。

29.97003
PixFmtstring

像素格式。

yuv420p
Langstring

语言。更多信息,请参见 FFmpeg 语言定义

und
CodecLongNamestring

编码格式长述名。

QuickTime/MOV
NumFramesstring

总帧数。

12
Rotatestring

视频旋转角度。

90
Bitratestring

码率。

2659.326
HasBFramesstring

是否有 B 帧。1 表示有,2 表示没有。

2
Profilestring

编码预置。

High
StartTimestring

开始时间。

0.000000
Darstring

编码显示分辨率比。

16:9
CodecNamestring

编码格式简述名。支持 mov、mp4、m4a、3gp、3g2、mj2。

mov
Durationstring

时长。

182.683000
Fpsstring

帧率。

29.97003
CodecTagstring

编码格式标记。

0x31637661
CodecTimeBasestring

编码时基。

1001/60000
Levelstring

编码等级。

40
AudioStreamListarray<object>

音频流列表。

AudioStreamobject

音频流数据。

Timebasestring

时基。

1/44100
Indexstring

音频流序号,标识音频流在整个媒体流中的位置。

1
SampleFmtstring

采样格式。

fltp
ChannelLayoutstring

声道输出样式。

stereo
Langstring

语言。更多信息,请参见 FFmpeg 语言定义

und
Sampleratestring

采样率。

44100
CodecLongNamestring

编码格式长述名。

AAC(Advanced Audio Coding)
Channelsstring

声道数。

2
NumFramesstring

总帧数。

100
Bitratestring

码率。

160.008
CodecTagStringstring

编码格式标记文本。

mp4a
StartTimestring

开始时间。

0.000000
CodecNamestring

编码格式简述名。支持 H264、mov、aac、avc、mpeg。

mov
Durationstring

时长。

182.591995
CodecTagstring

编码格式标记。

0x6134706d
CodecTimeBasestring

编码时基。

1/44100
SubtitleStreamListarray<object>

字幕流列表。

SubtitleStreamobject

字幕流数据。

Indexstring

字幕流序号,标识字幕流在整个媒体流中的位置。

3
Langstring

语言。更多信息,请参见 FFmpeg 语言定义

und
Formatobject

格式信息。

StartTimestring

起始时间。

0.000000
NumProgramsstring

节目流总数。

2
Sizestring

文件大小。

2647692
NumStreamsstring

媒体流总数。

2
FormatLongNamestring

容器/封装格式长述名。

QuickTime/MOV
Durationstring

总时长。

7.965000
Bitratestring

码率。

2659.326
FormatNamestring

容器/封装格式简述名,支持 mov,mp4,m4a,3gp,3g2,mj2。

mov
Descriptionstring

描述。

This is description ****
Sizestring

文件大小。

2647692
Widthstring

宽。

1920
CoverURLstring

封面的 OSS Bucket。

http://example-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example-****.png
SnapshotListarray<object>

截图列表。

Snapshotobject

截图文件数据。

Typestring

截图类型。取值:

  • Single:单张。

  • Sequence:序列。

Sequence
MediaWorkflowIdstring

产生截图文件的工作流 ID。

6cc3aa66d1cb4bb2adf14e726c0a****
ActivityNamestring

产生截图文件的工作流活动名称。

example-activity1-****
Countstring

截图张数。此值只在 TypeSequence 时有意义。

5
MediaWorkflowNamestring

产生截图文件的工作流。

example-workflow-****
Fileobject

截图文件。

Statestring

文件状态。取值:

  • Normal:正常。

  • Deleted:已删除。

Normal
URLstring

截图文件的 OSS Bucket。

http://example1-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example111-****.png
RunIdListarray

实例列表。

RunIdstring

实例 ID。

{"RunId":["47b42486019c4f688bf144c1a6ba****"]}
Durationstring

时长。

7.965000
Fpsstring

帧率。

25.0
Titlestring

标题。

example-title-****
Formatstring

编码格式。支持 mov,mp4,m4a,3gp,3g2,mj2。

mov
RequestIdstring

请求 ID。

283DC68C-146F-4489-A2A1-2F88F1472A56

示例

正常返回示例

JSON格式

{
  "NonExistMediaIds": {
    "MediaId": [
      "{\"MediaId\":[e26cfa29e784402388463f61dbec****]}"
    ]
  },
  "MediaList": {
    "Media": [
      {
        "CreationTime": "2016-09-14T08:30:33Z",
        "CateId": 1,
        "Height": "1080",
        "CensorState": "Initiated",
        "Tags": {
          "Tag": [
            "tag1,tag2"
          ]
        },
        "PlayList": {
          "Play": [
            {
              "Encryption": "0",
              "Height": "1080",
              "Bitrate": "2659.326",
              "File": {
                "State": "Normal",
                "URL": "http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4"
              },
              "MediaWorkflowId": "93ab850b4f6f44eab54b6e91d24d****",
              "Width": "760",
              "Size": "2647692",
              "Fps": "25.0",
              "Duration": "7.965000",
              "ActivityName": "example-activity-****",
              "Format": "mp4",
              "MediaWorkflowName": "example-mediaworkflow-****"
            }
          ]
        },
        "Bitrate": "2659.326",
        "MediaId": "3e1cd21131a94525be55acf65888****",
        "File": {
          "State": "Normal",
          "URL": "http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4"
        },
        "SummaryList": {
          "Summary": [
            {
              "Type": "Video",
              "MediaWorkflowId": "93ab850b4f6f44eab54b6e91d24d****",
              "ActivityName": "example-activity-****",
              "MediaWorkflowName": "example-mediaworkflow-****",
              "File": {
                "State": "Normal",
                "URL": "http://example-bucket-****.oss-cn-hangzhou.aliyuncs.com//example-****.mp4"
              }
            }
          ]
        },
        "PublishState": "Published",
        "MediaInfo": {
          "Streams": {
            "VideoStreamList": {
              "VideoStream": [
                {
                  "Sar": "1:1",
                  "Height": "1080",
                  "CodecTagString": "avc1",
                  "NetworkCost": {
                    "PreloadTime": "0.01",
                    "AvgBitrate": "2659.326",
                    "CostBandwidth": "100"
                  },
                  "Width": "100",
                  "Index": "5",
                  "Timebase": "1/30000",
                  "AvgFPS": "29.97003",
                  "PixFmt": "yuv420p",
                  "Lang": "und",
                  "CodecLongName": "QuickTime/MOV",
                  "NumFrames": "12",
                  "Rotate": "90",
                  "Bitrate": "2659.326",
                  "HasBFrames": "2",
                  "Profile": "High",
                  "StartTime": "0.000000",
                  "Dar": "16:9",
                  "CodecName": "mov",
                  "Duration": "182.683000",
                  "Fps": "29.97003",
                  "CodecTag": "0x31637661",
                  "CodecTimeBase": "1001/60000",
                  "Level": "40"
                }
              ]
            },
            "AudioStreamList": {
              "AudioStream": [
                {
                  "Timebase": "1/44100",
                  "Index": "1",
                  "SampleFmt": "fltp",
                  "ChannelLayout": "stereo",
                  "Lang": "und",
                  "Samplerate": "44100",
                  "CodecLongName": "AAC(Advanced Audio Coding)",
                  "Channels": "2",
                  "NumFrames": "100",
                  "Bitrate": "160.008",
                  "CodecTagString": "mp4a",
                  "StartTime": "0.000000",
                  "CodecName": "mov",
                  "Duration": "182.591995",
                  "CodecTag": "0x6134706d",
                  "CodecTimeBase": "1/44100"
                }
              ]
            },
            "SubtitleStreamList": {
              "SubtitleStream": [
                {
                  "Index": "3",
                  "Lang": "und"
                }
              ]
            }
          },
          "Format": {
            "StartTime": "0.000000",
            "NumPrograms": "2",
            "Size": "2647692",
            "NumStreams": "2",
            "FormatLongName": "QuickTime/MOV",
            "Duration": "7.965000",
            "Bitrate": "2659.326",
            "FormatName": "mov"
          }
        },
        "Description": "This is description ****",
        "Size": "2647692",
        "Width": "1920",
        "CoverURL": "http://example-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example-****.png",
        "SnapshotList": {
          "Snapshot": [
            {
              "Type": "Sequence",
              "MediaWorkflowId": "6cc3aa66d1cb4bb2adf14e726c0a****",
              "ActivityName": "example-activity1-****",
              "Count": "5",
              "MediaWorkflowName": "example-workflow-****",
              "File": {
                "State": "Normal",
                "URL": "http://example1-bucket1-****.oss-cn-hangzhou.aliyuncs.com//example111-****.png"
              }
            }
          ]
        },
        "RunIdList": {
          "RunId": [
            "{\"RunId\":[\"47b42486019c4f688bf144c1a6ba****\"]}"
          ]
        },
        "Duration": "7.965000",
        "Fps": "25.0",
        "Title": "example-title-****",
        "Format": "mov"
      }
    ]
  },
  "RequestId": "283DC68C-146F-4489-A2A1-2F88F1472A56"
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史