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

GetVideoByGid - 单个获取视频播放链接(入参无需vid)

最近更新时间2024.03.01 10:48:24

首次发布时间2021.08.20 16:54:35

本接口支持无需传递Vid参数,即可获取可播放的资源链接。

使用场景

  • 接口使用方式:
    • 视频播放时,调用接口获取播放链接,判断VideoStatus字段,active时为可播放,可避免下发后因内容状态变更导致的链接失效。
  • 视频url有效期:

请求说明

  • 请求方式:POST
  • 请求地址:https://cms.volcengineapi.com?Action=GetVideoByGid&Version=2021-01-01
  • 请求头:ServiceName: volc_content_api

调试

请求参数

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

Query

参数
类型
是否必填
示例值
描述
Action
String

GetVideoByGid

要执行的操作,取值:GetVideoByGid

Version
String

2021-01-01

API的版本,取值:2021-01-01

Body

参数
类型
是否必填
示例值
描述
GroupId
Long

内容ID。

返回参数

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

参数
类型
示例值
描述
Data
VideoDataWithGid

响应数据

请求示例

{
    "GroupId":12304
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "02162938737815900000000000000000000ffff0acc1c0d448cef",
        "Action": "GetVideoByGid",
        "Version": "2021-01-01",
        "Service": "volc_content_api",
        "Region": "cn-north-1"
    },
    "Data": {
        "PosterUrl": "...",
        "VideoDuration": 242.5,
        "VideoId": "shilivid",
        "VideoList": [
            {
                "Definition": "360p",
                "MainUrl": "...",
                "Size": 5405063,
                "Height": 360,
                "Width": 640
            },
            
        ],
        "RequestId": "02162938737815900000000000000000000ffff0acc1c0d448cef",
        "VideoStatus": "active",
        "GroupId": 12304
    },
    "BaseResp": {
        "StatusMessage": "success",
        "StatusCode": 1000
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
200
1002
服务未知错误

请联系火山引擎技术人员

200
1001
参数错误

返回具体的参数错误描述