You need to enable JavaScript to run this app.
导航

查询媒资信息

最近更新时间2024.02.29 18:03:34

首次发布时间2021.02.23 10:42:38

此接口用于查询媒资信息。

使用说明

您可以通过 Vid 查询到视频基础信息、源视频信息及转码视频信息。

注意事项

请求频率:单用户请求频率限制为 10 次/秒

请求说明

请求地址:https://vod.volcengineapi.com?Action=GetMediaInfos&Version=2022-12-01

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数

参数类型是否必选示例值描述
ActionStringGetMediaInfos接口名称。当前 API 的名称为 GetMediaInfos
VersionString2022-12-01接口版本。当前 API 的版本为 2022-12-01
VidsStringv02b69g10000***eldb8vjafvmg视频 ID 列表。多个 Vid 组成的字符串用 , 隔开。单次最多支持 20 个。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数

参数类型示例值描述
MediaInfoListArray of MediaInfoList-音视频信息列表。
NotExistVidsArray of String["v0dc24g10001cm***s1v0lve1gj96g"]不存在的视频 Vid 列表。

MediaInfoList

参数类型示例值描述
BasicInfoObject of BasicInfo-音视频基础信息。
SourceInfoObject of SourceInfo-源视频信息。
TranscodeInfosArray of TranscodeInfos-转码视频信息列表。

BasicInfo

参数类型示例值描述
SpaceNameStringvod-v2-test点播空间名称。
VidStringv02b69g10000***eldb8vjafvmg音视频 ID。
TitleString视频音视频名称。
DescriptionString视频测试音视频描述。
PosterUriStringtos-cn-v-febf3a/9******783b00c8beb40724dee封面图对象存储地址。

PublishStatus

String

Unpublished

发布状态,取值如下:

  • Published:发布。
  • Unpublished:未发布。
TagsArray of String[]音视频标签列表。
ClassificationObject of Classification-音视频分类信息。
CreateTimeString2022-12-28T08:57:58Z音视频创建时间。

TosStorageClass

String

STANDARD

视频存储类型。取值如下:

  • STANDARD:标准存储。
  • ARCHIVE:归档存储。
  • IA:低频存储。

VodUploadSource

String

upload

音视频来源。多个来源用 , 英文逗号分隔。取值如下:

  • upload:上传
  • live:直播录制
  • rtc:RTC 录制
  • url_upload:URL 批量上传
  • media_process:视频处理
  • media_edit:视频剪辑
HlsMediaSizeFloat0HlS 视频总和大小。

SourceInfo

参数类型示例值描述
FileIdStringv02b69g10***ldb8vjafvmg文件 ID。
Md5Stringb9fd116504b***88e59a824878f07aHash 值。

FileType

String

video

文件类型。取值如下:

  • video:视频。
  • audio:音频。
CodecStringh264编码格式。
HeightInteger270视频高度,单位为 px。
WidthInteger480视频宽度,单位为 px。
FormatStringMP4文件格式。
DurationFloat2.944视频时长,单位为 s。
SizeDouble104847文件大小,单位为字节。
StoreUriStringtos-cn-v-febf3a/daeba******a18e61e1aebfaf39aa.mp4对象存储地址。
DefinitionStringunknown清晰度。
BitrateInteger284910码率,单位为 bps。
FpsFloat25帧率,单位为 fps。
CreateTimeString2022-12-28T08:57:58Z创建时间。
QualityStringhigher音频质量。

DynamicRange

String

SDR

动态范围。取值如下:

  • HDR
  • SDR

TosStorageClass

String

STANDARD

视频存储类型。取值如下:

  • STANDARD:标准存储。
  • ARCHIVE:归档存储。
  • IA:低频存储。

TranscodeInfos

参数类型示例值描述
FileIdStringv020c9g10001***hs1v0go2sgujq0文件 ID。
Md5Stringdd9fd3ad7f99f***ce70609aec68589HASH 值。

FileType

String

video

文件类型。取值如下:

  • video:视频。
  • audio:音频。
LogoTypeStringaLogo 类型。
EncryptBooleanfalse是否加密。
FormatStringmp3文件格式。
DurationFloat2.944时长,单位为 s。
SizeDouble104847文件大小,单位为字节。
StoreUriStringtos-cn-v/34fdg***58sd.mp4对象存储地址。
VideoStreamMetaObject of VideoStreamMeta-视频流信息。
AudioStreamMetaObject of AudioStreamMeta-音频流信息。
CreateTimeString2021-04-02T02:47:33Z创建时间。
DynamicRangeStringHDR动态范围。

TosStorageClass

String

STANDARD

视频存储类型。取值如下:

  • STANDARD:标准存储;
  • ARCHIVE:归档存储。
  • IA:低频存储。

Classification

参数类型示例值描述
SpaceNameStringtest点播空间名称。
ClassificationIdLong1643分类 ID。

Level

Long

1

分类级别:

  • 1:一级分类
  • 2:二级分类
  • 3:三级分类
ClassificationString01分类名称。
ParentClassificationIdLong1345父分类 ID。
SubClassificationObject of SubClassification-子分类信息。
SubClassificationTreesArray of SubClassificationTrees-子分类列表。
CreatedAtString2022-02-18T15:08:07+08:00创建时间。

VideoStreamMeta

参数类型示例值描述
CodecStringh264视频编码格式。
HeightInteger270视频高度,单位为 px。
WidthInteger480视频宽度,单位为 px。
DurationFloat2.944视频时长,单位为 s。
DefinitionString720p视频清晰度。
BitrateInteger284910视频码率,单位为 bps。
FpsFloat25帧率。

AudioStreamMeta

参数类型示例值描述
CodecStringaac音频编码格式。
DurationFloat2.943音频时长,单位为 s。
SampleRateInteger44100音频采样率,单位为 Hz。
BitrateInteger127658音频码率,单位为 bps。
QualityStringhigher音频质量。

请求示例

https://vod.volcengineapi.com?Action=GetMediaInfos&Version=2022-12-01&Vids=v02b69g10000***eldb8vjafvmg

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20221228165***8DFF635830F5C63D",
    "Action": "GetMediaInfos",
    "Version": "2022-12-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "MediaInfoList": [
      {
        "BasicInfo": {
          "SpaceName": "vod-v2-test",
          "Vid": "v02b69g10000***eldb8vjafvmg",
          "Title": "",
          "Description": "",
          "PosterUri": "tos-cn-v-febf3a/9******783b00c8beb40724dee",
          "PublishStatus": "Unpublished",
          "Tags": [],
          "CreateTime": "2022-12-28T08:57:58Z",
          "Classification": null,
          "TosStorageClass": "STANDARD"
        },
        "SourceInfo": {
          "FileId": "v02b69g10***ldb8vjafvmg",
          "Md5": "b9fd116504b***88e59a824878f07a",
          "FileType": "video",
          "Codec": "h264",
          "Height": 270,
          "Width": 480,
          "Format": "MP4",
          "Duration": 2.944,
          "Size": 104847,
          "StoreUri": "tos-cn-v-febf3a/daeba******a18e61e1aebfaf39aa.mp4",
          "Definition": "unknown",
          "Bitrate": 284910,
          "Fps": 25,
          "CreateTime": "2022-12-28T08:57:58Z",
          "Quality": "",
          "DynamicRange": "SDR",
          "VideoStreamMeta": {
            "Codec": "h264",
            "Height": 270,
            "Width": 480,
            "Duration": 2.944,
            "Definition": "unknown",
            "Bitrate": 284910,
            "Fps": 25
          },
          "AudioStreamMeta": {
            "Codec": "",
            "Duration": 2.943,
            "SampleRate": 44100,
            "Bitrate": 127658,
            "Quality": ""
          },
          "TosStorageClass": "STANDARD"
        },
        "TranscodeInfos": []
      }
    ],
    "NotExistVids": []
  }
}

错误码

下表列举了本接口特有的错误码。如需了解更多错误码,更多信息请见公共错误码

状态码错误码错误信息说明
400ItemLimitExceeded-请求参数包含的 Vid 数量超过 20。

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK,支持多种编程语言,帮助您实现快速开发。建议使用服务端 SDK 来调用 API。此 API 各语言调用的示例代码,请参考如下: