GetVideoPlayInfo - 获取视频播放信息--视频点播-火山引擎

文档中心

立即注册

导航

GetVideoPlayInfo - 获取视频播放信息

最近更新时间：2025.10.24 19:49:14首次发布时间：2025.10.24 19:49:14

调用 GetVideoPlayInfo 接口通过 Vid 获取单个视频的播放信息。包含视频的播放地址、宽高信息、发布状态、转码信息、原始视频的信息等。

请求说明

请求方式：GET
请求地址：https://vod.volcengineapi.com?Action=GetVideoPlayInfo&Version=2018-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetVideoPlayInfo`	接口名称。当前 API 的名称为 `GetVideoPlayInfo`。
Version	String	是	`2018-01-01`	接口版本。当前 API 的版本为 `2018-01-01`。
DataType	String	是	`0`	视频的数据类型。
OutputType	String	是	`CDN`	视频的输出类型。
Space	String	是	`yhss`	视频所存储的空间名称。
Vid	String	是	`v03819g100xxxxxxxx`	视频 ID。

返回参数

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

参数	类型	示例值	描述
VideoDetail	Object	`-`	视频信息。
SpaceName	String	`yhss`	视频所属的空间名称。
Vid	String	`v03819g10065d3ci6c2ljht8h5dsxxxx`	视频 ID。
VidBucketType	Integer	`1`	视频所属的存储桶类型。
VideoDetailInfo	Object	`-`	视频的详细信息。
Title	String	`1-龙神之怒.mp4`	视频标题。
Vid	String	`v03819xxxxxxxds53bg`	视频 ID。
Filename	String	`37b01x2409275`	视频所属的文件名称。
PublishStatus	String	`Published`	视频的发布状态，支持的取值如下所示。 `Published`：已发布； `Unpublished`：未发布； `Deleted`：已删除。
Duration	Float	`117.92`	视频的时长，单位为秒。
Codec	String	`h264`	视频的编码格式。取值如下： `h264`：（默认）H.264 `h265`：H.265
Height	Integer	`1920`	视频高度，单位为像素。
Width	Integer	`1080`	视频宽度，单位为像素。
Format	String	`mp4`	视频的格式类型，取值如下。 `MP4` `DASH` `HLS` `FLV` `TS`
Size	Integer	`247448377`	视频大小，单位为字节。
Bitrate	Integer	`16787542`	视频的比特率，表示视频数据传输的速率，单位为比特每秒（bps）。
Tags	String[]	`["动作","冒险","科幻"]`	视频的标签信息。
Description	String	`这是一段展示龙神之怒的精彩视频片段，包含了激烈的战斗场面和震撼的特效。`	视频的描述信息。
PosterUrl	String	`https://console-image-cn.volcvod.com/tos-vod-cn-v-444d83ex9637/ab4beecx77441391xxxxx5d4~noop.jpeg?sign=1760854520-r0-u0-e702c1e9356c58f2a40a926a075bbef0`	素材的封面图 URL。
PlayInfo	Object	`-`	视频的播放信息。
MainPlayUrl	String	`https://example.com/video/play/main/v03819g10065d3ci6c2ljht8h5dsxxxx.mp4`	视频的主播放地址 URL。当视频状态为 `2`（播放地址可用）时，该地址有效。
BackupPlayUrl	String	`https://example.com/video/play/backup/v03819g10065d3ci6c2ljht8h5dsxxxx.mp4`	视频的备用播放地址 URL，当主播放地址不可用时，可使用该地址播放视频内容。
Status	Integer	`2`	视频播放状态。支持的取值如下。 `2`：播放地址可用；其他值：播放地址不可用。
PosterInfo	Object	`-`	视频的封面图信息。
MainPosterUri	String	`tos-vod-cn-v-444d83exxxxxxx09637/ab4beecxx5a5xd4`	视频主封面图的 URI。
BackupPosterUris	String[]	`["tos-vod-cn-v-444d83exxxxxxx09637/ab4beecxx5a5xd4}]`	视频备用封面图的 URI 列表，当主封面图不可用时，可使用该列表中的 URI 获取封面图。
MainPosterInfo	Object	`-`	视频主封面图的详细信息。
PosterUri	String	`tos-vod-cn-v-444d83exxxxxxx09637/ab4beecxx5a5xd4`	视频主封面图的 URI。
PosterUrl	String	`https://console-image-cn.volcvod.com/tos-vod-cn-v-444d83exxxxxxx09637/ab4beecxx5a5xd4~noop.jpeg?sign=1760854520-r0-u0-e702c1e9356c58fxxxx5bbef0`	视频主封面图的 URL 地址。
BackupPosterInfo	String[]	`[]`	视频备用封面图的详细信息数组，当主封面图不可用时，可使用该数组中的信息获取封面图。
CreatedTime	String	`2025-09-28 20:00:47`	视频的创建时间，格式为 `YYYY-MM-DD HH:MM:SS`。
UpdatedTime	String	`2025-09-28 20:00:50`	视频的最后更新时间，格式为 `YYYY-MM-DD HH:MM:SS`。
CategoryTags	String[]	`["电影","动作","冒险"]`	视频的分类标签列表。
Classification	Null	`-`	视频的分类信息。
TosStorageClass	String	`STANDARD`	视频在 TOS（对象存储）中的存储类型。支持的取值如下。 `STANDARD`：标准存储； `STANDARD_IA`：低频访问存储； `ARCHIVE`：归档存储。
DynamicRange	String	`SDR`	视频的动态范围类型，支持的取值如下。 `SDR`：标准动态范围； `HDR`：高动态范围。
OuterPosterUrl	String	`https://example.com/external-poster.jpg`	视频的外部封面图 URL 地址。
FileType	String	`video`	文件类型。
StoreUri	String	`tos-vod-cn-v-444d83ed89509637/37b0cxxxxxx542409275`	视频文件的储存地址。
Md5	String	`d41d8cd98f00b204e98xxx`	视频文件的 MD5 校验值。
VodUploadSource	String	`upload`	视频的上传来源。取值如下： `upload`：通过视频点播控制台、客户端上传 SDK、视频点播服务端 SDK 等方式上传至视频点播的视频。 `live`：通过火山引擎视频直播录制并存储至视频点播的视频。 `rtc`：通过火山引擎 RTC 录制并存储至视频点播的视频。 `url_upload`：通过 URL 批量拉取方式上传至视频点播的视频。 `media_process`：通过视频点播媒体处理服务生成的、会生成新 Vid 的视频。例如您通过多媒体 AI 模板生成的精彩剪辑，系统会单独生成 Vid。 `media_edit`：通过视频点播剪辑服务生产的视频。
BlockStatus	String	`Normal`	视频的封禁状态，分为 `Blocked` 和 `Normal`。
HlsMediaSize	Integer	`0`	HLS 格式视频的媒体文件大小，单位为字节。
OriginalVideoInfo	Object	`-`	原始视频的详细信息。
FileID	String	`v038xxxxxds53bg`	视频文件 ID。
FileName	String	`37b01xxxxx542409275`	视频所属的文件名称。
Definition	String	`original`	视频分辨率。`original`表示原始清晰度。
Format	String	`mp4`	视频的格式类型，取值如下。 `MP4` `DASH` `HLS` `FLV` `TS`
Codec	String	`h264`	视频的编码格式。取值如下： `h264`：（默认）H.264 `h265`：H.265
EncodedType	String		视频的转码类型。
Duration	Float	`117.92`	视频的时长，单位为秒。
Quality	String		视频质量。
LogoType	String		视频的水印贴片标签。
Height	Integer	`1920`	视频高度，单位为像素。
Width	Integer	`1080`	视频宽度，单位为像素。
Bitrate	Integer	`16787542`	视频的比特率，表示视频数据传输的速率，单位为比特每秒（bps）。
Size	Integer	`247448377`	视频大小，单位为字节。
Fps	Integer	`0`	视频帧率，单位为字节。
PlayInfo	Object	`-`	视频的播放信息。
MainPlayUrl	String	`https://example.com/video/play/main/v03819g10065d3ci6c2ljht8h5dsxxxx.mp4`	视频的主播放地址 URL。当视频状态为 `2`（播放地址可用）时，该地址有效。
BackupPlayUrl	String	`https://example.com/video/play/backup/v03819g10065d3ci6c2ljht8h5dsxxxx.mp4`	视频的备用播放地址 URL，当主播放地址不可用时，可使用该地址播放视频内容。
Status	Integer	`2`	视频播放状态。支持的取值如下。 `2`：播放地址可用；其他值：播放地址不可用。
SubtitleDetails	String[]	`[]`	视频的字幕信息列表。
CreatedTime	String	`2025-09-28 20:00:47`	视频的创建时间，格式为 `YYYY-MM-DD HH:MM:SS`。
UpdatedTime	String	`2025-09-28 20:00:50`	视频的最后更新时间，格式为 `YYYY-MM-DD HH:MM:SS`。
PlayScene	String	`web`	视频的播放场景。
TosStorageClass	String	`STANDARD`	原始视频在 TOS（对象存储）中的存储类型。支持的取值如下。 `STANDARD`：标准存储； `STANDARD_IA`：低频访问存储； `ARCHIVE`：归档存储。
FileType	String	`video`	文件类型。
DynamicRange	String	`SDR`	视频的动态范围类型，支持的取值如下。 `SDR`：标准动态范围； `HDR`：高动态范围。
AudioStreamMeta	Object	`-`	音频流信息。
Duration	Float	`117.92`	音频流的时长，单位为秒。
SampleRate	Integer	`48000`	音频流的采样率，单位为赫兹（Hz）。
Bitrate	Integer	`317328`	音频流的比特率，单位为比特每秒（bps）。
Codec	String	`aac`	音频流的编码格式。
ShadowLogoType	String	`standard`	视频的阴影水印类型。
ReplaceInfo	Null	`-`	视频替换信息。
DrmType	String	`none`	原始视频的数字版权管理（DRM）类型。支持的取值如下。 `None`：未启用 DRM； `Widevine`：Widevine DRM； `FairPlay`：FairPlay DRM； `PlayReady`：PlayReady DRM。
EncodedVideoInfos	String[]	`[]`	视频的转码信息。
LogoEncodedVideoInfos	String[]	`[]`	视频水印转码信息。
AbrMasterFileInfos	String[]	`[]`	视频的 ABR（自适应码率）主文件信息列表。
BaseResp	Object	`-`	基础响应信息。
StatusCode	Integer	`0`	接口请求的状态码。`0`表示成功，其他值表示不同的错误状态。
StatusMessage	String	`success`	接口请求的状态信息，用于描述请求的处理结果。当 `StatusCode` 为 `0` 时，通常返回 `success`表示成功；其他状态码时返回具体的错误信息。
Extra	Null	`-`	接口请求的扩展信息。

请求示例

GET https://vod.volcengineapi.com?Action=GetVideoPlayInfo&Version=2018-01-01&DataType=0&OutputType=CDN&Space=yhss&Vid=v03819g1006xxxxxx8h5ds53bg

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230604110420****100232280022D31",
    "Action": "GetVideoPlayInfo",
    "Version": "2018-01-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "VideoDetail": {
      "SpaceName": "yhss",
      "Vid": "v03819x53bg",
      "VidBucketType": 1,
      "VideoDetailInfo": {
        "Title": "1-龙神之怒.mp4",
        "Vid": "v03819xxxxxxxds53bg",
        "Filename": "37b01x2409275",
        "PublishStatus": "Published",
        "Duration": 117.92,
        "Codec": "h264",
        "Height": 1920,
        "Width": 1080,
        "Format": "MP4",
        "Size": 247448377,
        "Bitrate": 16787542,
        "Tags": [
          ""
        ],
        "Description": "",
        "PosterUrl": "https://console-image-cn.volcvod.com/tos-vod-cn-v-444d83ex9637/ab4beecx77441391cbbxa5d4~noop.jpeg?sign=1760854520-r0-u0-e702c1e9356c58f2a40a926a075bbef0",
        "PlayInfo": {
          "MainPlayUrl": "",
          "BackupPlayUrl": "",
          "Status": 2
        },
        "PosterInfo": {
          "MainPosterUri": "tos-vod-cn-v-444d83exxxxxxx09637/ab4beecxx5a5xd4",
          "BackupPosterUris": [
            ""
          ],
          "MainPosterInfo": {
            "PosterUri": "tos-vod-cn-v-444d83exxxxxxx09637/ab4beecxx5a5xd4",
            "PosterUrl": "https://console-image-cn.volcvod.com/tos-vod-cn-v-444d83exxxxxxx09637/ab4beecxx5a5xd4~noop.jpeg?sign=1760854520-r0-u0-e702c1e9356c58fxxxx5bbef0"
          },
          "BackupPosterInfo": [
            ""
          ]
        },
        "CreatedTime": "2025-09-28 20:00:47",
        "UpdatedTime": "2025-09-28 20:00:50",
        "CategoryTags": [
          ""
        ],
        "Classification": null,
        "TosStorageClass": "STANDARD",
        "DynamicRange": "SDR",
        "OuterPosterUrl": "",
        "FileType": "video",
        "StoreUri": "tos-vod-cn-v-444d83ed89509637/37b0cxxxxxx542409275",
        "Md5": "",
        "VodUploadSource": "upload",
        "BlockStatus": "",
        "HlsMediaSize": 0
      },
      "OriginalVideoInfo": {
        "FileID": "v038xxxxxds53bg",
        "FileName": "37b01xxxxx542409275",
        "Definition": "original",
        "Format": "MP4",
        "Codec": "h264",
        "EncodedType": "",
        "Duration": 117.92,
        "Quality": "",
        "LogoType": "",
        "Height": 1920,
        "Width": 1080,
        "Bitrate": 16787542,
        "Size": 247448377,
        "Fps": 0,
        "PlayInfo": {
          "MainPlayUrl": "",
          "BackupPlayUrl": "",
          "Status": 2
        },
        "SubtitleDetails": [
          ""
        ],
        "CreatedTime": "2025-09-28 20:00:47",
        "UpdatedTime": "2025-09-28 20:00:50",
        "PlayScene": "",
        "TosStorageClass": "STANDARD",
        "FileType": "video",
        "DynamicRange": "SDR",
        "AudioStreamMeta": {
          "Duration": 117.92,
          "SampleRate": 48000,
          "Bitrate": 317328,
          "Codec": ""
        },
        "ShadowLogoType": "",
        "ReplaceInfo": null,
        "DrmType": ""
      },
      "EncodedVideoInfos": [
        ""
      ],
      "LogoEncodedVideoInfos": [
        ""
      ],
      "AbrMasterFileInfos": [
        ""
      ]
    },
    "BaseResp": {
      "StatusCode": 0,
      "StatusMessage": "success",
      "Extra": null
    }
  }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。