调用 ListSnapshots 接口获取指定 Vid 的截图结果。

使用说明

此接口的返回结果中包含截图下载地址。此外，您也可以通过自行拼接的方式获取图片地址。图片地址的拼接说明如下：

• 规则：http(s)://{domain}/{store_uri}~tplv-vod-noop.image
• 说明：http(s)://点播封面加速域名/截图存储地址～模板配置.图片输出格式。其中模板配置详情请参见封面图处理模板。
• 示例：http://www.example.com/tos-cn-v-abcd/example~tplv-vod-noop.image

注意事项

• 如需获取截图的访问地址，请先配置图片加速域名。具体请见添加域名。

请求说明

请求地址：https://vod.volcengineapi.com?Action=ListSnapshots&Version=2021-01-01

调试

请求参数

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

返回参数

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

请求示例

https://vod.volcengineapi.com?Action=ListSnapshots&Version=2021-01-01&Vid=v0dc24g10***s1v0ipljnh4h0

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202312211758***DEB895D4F863495B9",
    "Action": "ListSnapshots",
    "Version": "2021-01-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "SpaceName": "test",
    "Vid": "v0dc24g10001cm***pljnh4h0",
    "PosterSnapshots": [
      {
        "Format": "jpeg",
        "Height": 360,
        "Width": 958,
        "StoreUri": "tos-vod-cn-v-03e4***3112705/12d74b97e37944***e524a7398c6",
        "Url": "https://example.test.com/tos-vod-cn-v-03e4d54***112705/12d74b97e3794***83e524a7398c6~noop.image"
      }
    ],
    "DynpostSnapshots": [
      {
        "Format": "webp",
        "Height": 360,
        "Width": 958,
        "StoreUri": "tos-vod-cn-v-03e4d54ef3***5/35d9efb1adf3***381e1d07e19",
        "Url": "https://example.test.com/tos-vod-cn-v-03e4d54***2705/35d9efb1adf345***81e1d07e19~noop.image"
      }
    ],
    "AnimatedPosterSnapshots": [
      {
        "Format": "webp",
        "Height": 360,
        "Width": 958,
        "StoreUri": "tos-vod-cn-v-03e4d***12705/ee230f69d69b45***8ef5843d5d8",
        "Url": "https://example.test.com/tos-vod-cn-v-03e4d54***12705/ee230f69d69b4***48ef5843d5d8~noop.image"
      }
    ],
    "AiDynpostSnapshots": [],
    "SpriteSnapshots": [
      {
        "Format": "jpeg",
        "ImgXLen": 5,
        "ImgYLen": 5,
        "CellWidth": 240,
        "CellHeight": 90,
        "Interval": 2,
        "CaptureNum": 6,
        "StoreUris": [
          "tos-vod-cn-v-03e4d54***12705/33b783a01d7a4***4a04f1f28b3436"
        ],
        "Urls": [
          "https://example.test.com/tos-vod-cn-v-03e4d***2705/33b783a01d7a4***04f1f28b3436~noop.image"
        ]
      }
    ],
    "VSamplePosterSnapshots": [
      {
        "StoreUris": [
          "tos-vod-cn-v-03e4d54***12705/737f0b92faf84***fecb9493290",
          "tos-vod-cn-v-03e4d5***12705/403810e1f986***61314bbf5b330",
          "tos-vod-cn-v-03e4d***12705/e7fc3fdde31***7a279f20e908"
        ],
        "ImgNum": 6,
        "CellWidth": 1436,
        "CellHeight": 540,
        "Interval": 2,
        "Format": "jpeg",
        "Duration": 11.4,
        "Urls": [
          "https://example.test.com/tos-vod-cn-v-03e4d54***2705/737f0b92faf***7231fecb9493290~noop.image",
          "https://example.test.com/tos-vod-cn-v-03e4d54***2705/403810e1f9***561314bbf5b330~noop.image",
          "https://example.test.com/tos-vod-cn-v-03e4d54***2705/e7fc3fdd***eaa7a279f20e908~noop.image"
        ],
        "LargeSnapshotUri": "",
        "LargeSnapshotDownloadUrl": "",
        "LargeSnapshotFillType": "",
        "Offsets": []
      }
    ]
  }
}

错误码

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

服务端 SDK

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

• Java
• Python
• PHP
• Go