SearchVideo - 搜索视频--视频点播-火山引擎

文档中心

立即注册

视频点播

剪辑素材管理

SearchVideo - 搜索视频

调用 SearchVideo 搜索视频，获取视频的集合信息，包含视频的基本信息、文件信息和扩展信息。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`SearchVideo`	接口名称。当前 API 的名称为 `SearchVideo`。
Version	String	是	`2018-01-01`	接口版本。当前 API 的版本为 `2018-01-01`。
AuditStatus	String	否	`Passed`	视频的审核状态，支持的取值如下所示。 `Passed`：审核通过； `Failed`：审核未通过； `Pending`：待审核。
DataType	String	否	`0`	视频的数据类型。
Limit	String	否	`12`	分页查询时每页返回的视频数量。
Offset	String	否	`0`	分页查询时的偏移量，表示从第几条记录开始返回数据。
Order	String	否	`Desc`	指定返回结果的排序方式。支持的取值如下所示。 `Desc`：降序； `Asc`：升序。
PublishStatus	String	否	`Published`	视频的发布状态，支持的取值如下所示。 `Published`：已发布； `Unpublished`：未发布； `Deleted`：已删除。
SortBy	String	否	`CreatedTime`	指定返回结果的排序依据字段，支持的取值如下所示。 `CreatedTime`：按创建时间排序； `UpdatedTime`：按更新时间排序； `ViewCount`：按观看次数排序。
Space	String	否	`yhss`	视频所属的空间名称。
Vid	String	否	`v02b69g10000***eldb8vjafvmg`	视频 ID。

返回参数

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

参数	类型	示例值	描述
VideoSet	Object	`-`	视频集合信息。
VideoInfos	Object[]	`-`	视频的信息列表。
Vid	String	`v0d819g1xxxxxxxt8c8te6m8g`	视频 ID
BasicInfo	Object	`-`	视频的基本信息。
PosterUri	String	`tos-vod-cn-v-444d8xxxxx37/oggpixxxxxxxoAAQaxAlBAIIiKsKG`	视频封面图片的 URI 地址，用于标识视频封面的存储位置。
PosterUrl	String	`https://console-image-cn.volcvod.com/tos-vod-cn-v-444d8xxx509637/oggpiXxxeNe9kiBHvoAAQaxAlBAIIiKsKG~noop.jpeg?sign=1760854189-r0-u0-db7752d6841f4xxxxx90b6265d5c7f`	视频封面图片的 URL 地址，可直接用于展示或下载。
UserReference	String	`vcloud-vedit/2024-yhss-VideoTrackToB-e010xxx5a8c6xxxxxba8da8a9`	用户自定义的引用标识，通常用于标识视频的来源或关联的业务信息。
Duration	Float	`15.046`	视频的时长，单位为秒。
CreatedTime	String	`2025-10-19 14:08:21`	视频的创建时间，格式为 `YYYY-MM-DD HH:MM:SS`。
PublishStatus	String	`Blocked`	视频的发布状态，表示视频当前是否可被公开访问。
TranscodeStatus	String	`Uploaded`	视频的转码状态。
Title	String	`视频`	视频标题。
Tags	String	`旅游,风景,4K`	视频的标签信息。
Description	String	`-`	视频的描述信息。
Category	String	`电影`	视频的分类。
UpdatedTime	String	`2025-10-19 14:08:21`	视频的最后更新时间，格式为 `YYYY-MM-DD HH:MM:SS`。
AuditStatus	Integer	`0`	视频的审核状态。
AuditDesc	String	`视频内容涉及敏感信息，审核未通过。`	视频的审核描述信息，说明视频审核的具体结果或原因。
Format	String	`MP4`	视频的格式类型，取值如下。 `MP4` `DASH` `HLS` `FLV` `TS`
Classification	Null	`-`	视频的分类信息。
TosStorageClass	String	`STANDARD`	视频在对象存储中的存储类型。支持的取值如下所示。 `STANDARD`：标准存储； `IA`：低频访问存储； `ARCHIVE`：归档存储。
VodUploadSource	String	`media_edit`	视频的上传来源。
BlockStatus	String	`Normal`	视频的封禁状态，分为 `Blocked` 和 `Normal`。
FileInfos	Object[]	`-`	视频文件信息列表。
FileID	String	`v0d819gxxxxxxxc8te6m8g`	视频文件 ID。
FileHash	String	`15ba48673xxxxx91a55ff3e2aea8`	视频文件的哈希值。
Height	Integer	`1280`	视频文件的高度，单位为像素。
Width	Integer	`720`	视频文件的宽度，单位为像素。
Duration	Float	`15.046`	视频文件的时长，单位为秒。
Size	Integer	`790132`	视频文件的大小，单位为字节。
Format	String	`MP4`	视频的格式类型，取值如下。 `MP4` `DASH` `HLS` `FLV` `TS`
Codec	String	`h264`	视频文件的编码格式。常见的编码格式包括 `h264`、`h265`等。
EncodedType	String	`h264`	视频的转码类型。
Definition	String	`unknown`	视频清晰度。
Bitrate	Integer	`420109`	视频平均码率，单位为Kbps。
LogoType	String	`watermark_001`	视频文件的水印贴片标签。
FileExt	Object	`-`	视频文件的扩展信息，包含帧率、视频质量、包偏移和版权信息等。
Fps	String	`30`	视频文件的帧率。
VQuality	String	`high`	视频文件的质量标识。
PktOffset	String	`123456`	视频文件的包偏移信息。
TTCopyright	String	`-`	视频文件的版权信息。
VideoExt	Object	`-`	视频的扩展信息，包含文件类型和大图信息。
FileType	String	`video`	文件类型。
BigThumbs	String	`https://example.com/big-thumbnail.jpg`	视频的大图信息，通常用于展示视频的高清缩略图或关键帧截图。
Total	Integer	`36`	返回查询视频的总数量。
BaseResp	Object	`-`	基础响应信息。
StatusCode	Integer	`0`	接口调用的状态码，用于标识请求的处理结果。状态码 `0`表示成功，其他值表示不同的错误情况。
StatusMessage	String	`success`	接口调用的状态信息，用于描述请求的处理结果。成功时为 `success`，失败时提供具体的错误信息或状态描述。
Extra	Null	`-`	额外的响应信息。

请求示例

GET https://vod.volcengineapi.com?Action=SearchVideo&Version=2018-01-01&AuditStatus=&DataType=0&Limit=12&Offset=0&Order=Desc&PublishStatus=&SortBy=CreatedTime&Space=xxxs&Vid=

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230604110420****100232280022D31",
    "Action": "SearchVideo",
    "Version": "2018-01-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result": {
    "VideoSet": {
      "VideoInfos": [
        {
          "Vid": "v0d819g1xxxxxxxt8c8te6m8g",
          "BasicInfo": {
            "PosterUri": "tos-vod-cn-v-444d8xxxxx37/oggpixxxxxxxoAAQaxAlBAIIiKsKG",
            "PosterUrl": "https://console-image-cn.volcvod.com/tos-vod-cn-v-444d8xxx509637/oggpiXxxeNe9kiBHvoAAQaxAlBAIIiKsKG~noop.jpeg?sign=1760854189-r0-u0-db7752d6841f4xxxxx90b6265d5c7f",
            "UserReference": "vcloud-vedit/2024-yhss-VideoTrackToB-e010xxx5a8c6xxxxxba8da8a9",
            "Duration": 15.046,
            "CreatedTime": "2025-10-19 14:08:21",
            "PublishStatus": "Blocked",
            "TranscodeStatus": "Uploaded",
            "Title": "",
            "Tags": "",
            "Description": "",
            "Category": "",
            "UpdatedTime": "2025-10-19 14:08:21",
            "AuditStatus": 0,
            "AuditDesc": "",
            "Format": "MP4",
            "Classification": null,
            "TosStorageClass": "STANDARD",
            "VodUploadSource": "media_edit",
            "BlockStatus": ""
          },
          "FileInfos": [
            {
              "FileID": "v0d819gxxxxxxxc8te6m8g",
              "FileHash": "15ba48673xxxxx91a55ff3e2aea8",
              "Height": 1280,
              "Width": 720,
              "Duration": 15.046,
              "Size": 790132,
              "Format": "MP4",
              "Codec": "h264",
              "EncodedType": "",
              "Definition": "unknown",
              "Bitrate": 420109,
              "LogoType": "",
              "FileExt": {
                "Fps": "",
                "VQuality": "",
                "PktOffset": "",
                "TTCopyright": ""
              }
            }
          ],
          "VideoExt": {
            "FileType": "video",
            "BigThumbs": ""
          }
        }
      ]
    },
    "Total": 36,
    "BaseResp": {
      "StatusCode": 0,
      "StatusMessage": "success",
      "Extra": null
    }
  }
}

错误码

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

最近更新时间：2026.02.02 14:58:48

这个页面对您有帮助吗？

有用

无用

视频点播

请求说明 #

调试 #

请求参数 #

Query #

返回参数 #

请求示例 #

返回示例 #

错误码 #