获取封面候选结果--视频点播-火山引擎

文档中心

立即注册

导航

获取封面候选结果

最近更新时间：2024.06.06 17:09:21首次发布时间：2021.02.23 10:42:40

此接口用于通过 Vid（视频 ID）获取封面候选结果。

请求说明

请求地址：https://vod.volcengineapi.com?Action=GetRecommendedPoster&Version=2020-08-01

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	`GetRecommendedPoster`	接口名称。当前 API 的名称为 `GetRecommendedPoster`。
Version	String	是	`2020-08-01`	接口版本。当前 API 的版本为 `2020-08-01`。
Vids	String	是	`v0dc24g10001***sps1v0lve1gj96g`	视频 ID 列表。多个 Vid 组成的字符串，中间用英文逗号 `,` 隔开。

返回参数

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

参数	类型	示例值	描述
StoreUriGroups	Object[]	`-`	封面图信息。
Vid	String	`Vid`	视频 ID。
StoreUris	String[]	`["tos-cn-p-0000/bca09b**ac0b32f16e334c", "tos-cn-p-0000/371b389ad**ae3e3b474048"]`	封面图存储地址列表。
NotExistVids	String[]	`-`	不存在的视频 ID 列表。

请求示例

https://vod.volcengineapi.com?Action=GetRecommendedPoster&Version=2020-08-01&Vids=v0dc24g10001***sps1v0lve1gj96g

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20231220180447D03B2E8E4D20408B888E",
    "Action": "GetRecommendedPoster",
    "Version": "2020-08-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "StoreUriGroups": [
      {
        "Vid": "v0dc24g1000***ps1v0lve1gj96g",
        "StoreUris": [
          "tos-cn-p-0000/bca09b7e24842***c0b32f16e334c",
          "tos-cn-p-0000/371b389ad248***938ae3e3b474048",
          "tos-cn-p-0000/8246dc83bb***90689eb936c420fea7",
          "tos-cn-p-0000/a17a0413***c130f17ccac02f0a8",
          "tos-cn-p-0000/3c9aae7***d261bc4b0b1ffa07",
          "tos-cn-p-0000/4e2e1cb***b3b9dae2a35534bd",
          "tos-cn-p-0000/a0b60c***e9fb5f7214decfe883",
          "tos-cn-p-0000/52c819***07af780fdcfff87e807"
        ]
      }
    ],
    "NotExistVids": []
  }
}

错误码

下表列举了本接口特有的错误码。如需了解更多错误码，详见视频点播公共错误码。

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

服务端 SDK

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