根据文件路径获取媒资信息--视频点播-火山引擎

文档中心

立即注册

导航

根据文件路径获取媒资信息

最近更新时间：2024.10.08 19:53:31首次发布时间：2023.11.17 18:14:01

此接口用于 DirectUrl 模式下通过 FileName（文件路径）获取媒资信息，包含该媒资对应的 Vid 或 Mid 等信息。

请求说明

请求地址：https://vod.volcengineapi.com?Action=ListFileMetaInfosByFileNames&Version=2023-07-01

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	`ListFileMetaInfosByFileNames`	接口名称。当前 API 的名称为 `ListFileMetaInfosByFileNames`。
Version	String	是	`2023-07-01`	接口版本。当前 API 的版本为 `2023-07-01`。
SpaceName	String	是	`test`	点播空间名称。可通过以下方式获取空间名称：在视频点播控制台空间管理页面查看当前账号下所有空间的名称。调用 ListSpace 接口获取当前账号下所有空间的名称。
FileNameEncodeds	String	否	`a%2Fb%2Fc,b%2Fb%2Fc`	URL 编码后的文件路径。用英文逗号 `,` 连接，一次最多传 30 个。您可在通过点播控制台视频管理页面获取文件路径。说明为了防止特殊字符比如逗号出现在 `FileName` 中，您需要将文件路径进行 URL 编码。对于含有保留字符（`$`, `&`, `+`, `,`, `/`, `:`, `;`, `=`, `?`, `@`）的 `FileName`，除了安全的字符（`@`、`&`、`=`、`+`、`$`）需要保留外，其余字符必须依据 RFC3986 协议进行 URLEncode。假设 `FileName` 为 `abc/ /!/*/'/(/;/:/@/&/=/+/$/,/?/#/[/1.mp4`，经过 URL 编码后为 `abc%2F%20%2F%21%2F%2A%2F%27%2F%28%2F%3B%2F:%2F@%2F&%2F=%2F+%2F$%2F%2C%2F%3F%2F%23%2F%5B%2F1.mp4` 。您必须传入 `FileNameEncodeds` 才看到返回数据。
BucketName	String	否	`YourBucketName`	挂载存储桶名称。

返回参数

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

参数	类型	示例值	描述
VodFileMetaInfos	Object[]	`-`	转码后文件媒资信息
Vid	String	`v02e61g10001**9s1v0h2fqmdk80`	视频 ID。说明如果媒资文件没有转码产物的话，返回的 `Vid` 与 `FileId` 值是一致的。
FileId	String	`v02e61g10001***9s1v0h2fqmdk80`	转码流 ID。
MaterialId	String		素材 ID。说明当返回列表中 `FileType` 参数为 `MaterialUri` 时，返回的 `MaterialId` 参数有具体 ID。
FileType	String	`MediaUri`	文件类型即 URI 所指类型。取值如下： `PosterUri`：封面图 URI `TranscodeUri`：转码流 URI `MediaUri`：媒资原片 URI `MaterialUri`：素材 URI `PostCandidateUri`：封面候选 URI `AnimatedImageUri`：反复循环截图 URI `DynpostUri`：动图 URI `PosterUriEx`：静态截图 URI `DrsChoiceUri` `Unknown`：未知类型
FileName	String	`a/b/c`	文件路径。
FileNameEncoded	String	`a%2Fb%2Fc`	转码后的文件路径。

请求示例

https://vod.volcengineapi.com?Action=ListFileMetaInfosByFileNames&Version=2023-07-01&SpaceName=test&FileNameEncodeds=a/b/c,b/b/c&BucketName=YourBucketName

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20231114111***0444837954B0F411E",
        "Action": "ListFileMetaInfosByFileNames",
        "Version": "2023-07-01",
        "Service": "vod",
        "Region": "cn-north-1"
    },
    "Result": {
        "VodFileMetaInfos": [
            {
                "Vid": "v02e61g10001**9s1v0h2fqmdk80",
                "FileId": "v02e61g10001***9s1v0h2fqmdk80",
                "MaterialId": "",
                "FileType": "MediaUri",
                "FileName": "a/b/c,b/b/c",
                "FileNameEncoded": "a%2Fb%2Fc,b%2Fb%2Fc"
            }
        ]
    }
}

错误码

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

服务端 SDK

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