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

文档中心

立即注册

导航

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

最近更新时间：2024.09.13 20:03:08首次发布时间：2024.05.30 15:20:39

此接口用于获取 DirectUrl 模式下的文件信息。可指定 SpaceName 空间名称、URL 编码的 FileName 文件路径等参数获取文件详细信息。

注意事项

请求频率：单用户请求频率限制为 100 次/秒。
请求参数 EncodedFileNames，为了防止特殊字符比如逗号出现在 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。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	`GetFileInfos`	接口名称。当前 API 的名称为 `GetFileInfos`。
Version	String	是	`2023-07-01`	接口版本。当前 API 的版本为 `2023-07-01`。
SpaceName	String	是	`test`	点播空间名称。获取方式如下：在视频点播控制台空间管理页面查看当前账号下所有空间的名称。调用 ListSpace 接口获取当前账号下所有空间的名称。
EncodedFileNames	String	是	`a%2Fb%2Fc`	需要查询的 URL 编码 `FileName`。用英文逗号 `,` 连接，一次最多传 30 个。可通过视频点播控制台，进入空间，在视频管理的详情中获取文件路径。
BucketName	String	否	`tos-vod-v-r3984tu***`	存储桶名称。
NeedDownloadUrl	Boolean	否	`true`	是否需要返回文件下载地址。默认值为 `false`。
DownloadUrlNetworkType	String	否	`vpc-inner`	文件下载地址网络类型。仅当 `NeedDownloadUrl` 为 `true` 时生效。当前仅支持设为 `vpc-inner`（默认值），即火山引擎私有网络 VPC 类型。
DownloadUrlExpire	Long	否	`3600`	文件下载地址过期时间，单位为秒。默认值为 3600，最大支持 12 小时。仅当 `NeedDownloadUrl` 为 `true` 时生效。

返回参数

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

参数	类型	示例值	描述
FileInfos	Object[]	`-`	文件信息。
FileName	String	`a/b/c`	文件路径。
EncodedFileName	String	`a%2Fb%2Fc`	URL 编码后的文件路径。
LastModifiedTime	String	`2024-05-11T11:51:06Z`	最新修改时间。日期格式要求符合 RFC3339 规范。
Size	Long	`32202259`	文件大小，单位为字节。
HashCrc64	String	`13315235144480327334`	根据数据生成短固定位数校验和。
StorageClass	String	`STANDARD`	文件存储类型，取值如下： `STANDARD`：标准存储 `ARCHIVE`：归档存储 `IA`：低频存储
DownloadUrl	String	`https://examplebucket.tos-cn-beijing.example.com/example.flv?X-Tos-Algorithm=TOS4-HMAC-SHA256&X-Tos-Credential=example&X-Tos-Date=20240913T092453Z&X-Tos-Expires=3600&X-Tos-Security-Token=example&X-Tos-Signature=example&X-Tos-SignedHeaders=host`	文件下载地址。仅当 `NeedDownloadUrl` 为 `true` 时返回。说明视频点播默认存储桶地域为华北cn-beijing，请确保您的 VPC 与该地域相通。使用 SubmitBlockObjectTasks 接口封禁文件不会影响该地址的下载。
NotExistFileNames	String[]	`[]`	不存在的文件路径。
NotExistEncodedFileNames	String[]	`[]`	不存在的 URL 编码格式文件路径。

请求示例

https://vod.volcengineapi.com?Action=GetFileInfos&Version=2023-07-01&SpaceName=test&EncodedFileNames=a/b/c&BucketName=tos-vod-v-r3984tu***

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202405119514375***8y7y8u8",
        "Action": "GetFileInfos",
        "Version": "vod",
        "Region": "cn-north-1"
    },
    "Result": {
       "FileInfos": [
            {
                "FileName": "a/b/c",
                "LastModifiedTime": "2024-05-11T11:51:06Z",
                "Size": "32202259",
                "StorageClass": "IA",
                "HashCrc64": "13315235144480327334",
                "EncodedFileName": "a%2Fb%2Fc"
            }
        ],
        "NotExistFileNames": [],
        "NotExistEncodedFileNames": []
    }
}

错误码

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