根据文件路径获取文件信息--veImageX-火山引擎

文档中心

立即注册

veImageX

请输入

资源管理

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

调用 GetFileInfos 获取指定路径的文件信息，例如文件下载地址、文档大小等。

注意事项

请求频率：单用户请求频率限制为 100 次/秒。
对于请求参数 EncodedFileNames，为了防止特殊字符比如逗号出现在 FileName 中，您需要将文件路径进行 URL 编码后使用。
- 对于含有保留字符（$, &, +, ,, /, :, ;, =, ?, @）的 FileName，除了安全的字符（@、&、=、+、$）需要保留外，其余字符必须依据 RFC3986 协议进行 URLEncode。
- 假设 FileName 为 abc/ /!/*/'/(/;/:/@/&/=/+/$/,/?/#/[/1.jpeg，经过 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.jpeg。

请求说明

请求方式：GET
请求地址：https://imagex.volcengineapi.com/?Action=GetFileInfos&Version=2023-05-01

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetFileInfos`	接口名称。当前 API 的名称为 `GetFileInfos`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
ServiceId	String	是	`8h**9q`	服务 ID，可从服务管理页面获取。注意确保服务的地域与您调用接口的地域一致。
EncodedFileNames	String	是	`a%2Fb%2Fc`	需要查询的 URL 编码后的文件路径。多个用英文逗号 `,` 连接，一次最多传 30 个。可在控制台指定服务的资源管理页面获取文件路径（资源 URI），并按照注意事项中的要求进行 URL 编码。
DownloadUrlNetworkType	String	否	`vpc-inner`	文件下载地址网络类型。当前仅支持设为 `vpc-inner`，即火山引擎私有网络 VPC 类型。
DownloadUrlExpire	Long	否	`3600`	文件下载地址过期时间，单位为秒。默认值为 `3600`，最大支持 12 小时。

返回参数

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

参数	类型	示例值	描述
FileInfos	Array of FileInfos	`-`	文件信息。
NotExistFileNames	Array of String	`[]`	不存在的文件路径。
NotExistEncodedFileNames	Array of String	`[]`	不存在的 URL 编码格式文件路径。

FileInfos

参数	类型	示例值	描述
FileName	String	`a/b/c`	文件路径。
EncodedFileName	String	`a%2Fb%2Fc`	URL 编码后的文件路径。
LastModifiedTime	String	`2024-05-11T11:51:06Z`	最新修改时间。日期格式要求符合 RFC3339 规范。
Size	String	`32202259`	文件大小，单位为字节。
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`	文件下载地址。

请求示例

GET https://imagex.volcengineapi.com/?Action=GetFileInfos&Version=2023-05-01&ServiceId=8h**9q&EncodedFileNames=a/b/c&DownloadUrlNetworkType=vpc-inner&DownloadUrlExpire=3600

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetFileInfos",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "FileInfos": [
            {
                "FileName": "a/b/c",
                "LastModifiedTime": "2024-05-11T11:51:06Z",
                "Size": "32202259",
                "StorageClass": "STANDARD",
                "EncodedFileName": "a%2Fb%2Fc",
                "DownloadUrl": "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"
            }
        ],
        "NotExistFileNames": [],
        "NotExistEncodedFileNames": []
    }
}

错误码

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

最近更新时间：2026.03.27 17:16:33

这个页面对您有帮助吗？

有用

无用

veImageX

注意事项 #

请求说明 #

调试 #

请求参数 #

Query #

返回参数 #

FileInfos #

请求示例 #

返回示例 #

错误码 #