获取资源 URL--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

获取资源 URL

最近更新时间：2024.11.14 14:02:34首次发布时间：2024.08.13 17:56:44

本接口支持获取指定服务下单个文件的原文件访问地址，若指定模板，可获取模板处理后结果图访问地址。

使用说明

若文件存储至素材托管服务下，则仅支持获取原图访问地址。若文件存储至图像处理服务下，默认情况下仅支持获取模板处理后结果图访问地址，如需获取原图访问地址，请开启源地址访问。

说明

您可在控制台服务管理或调用 GetImageService 查询服务类型。

注意事项

请求频率：单用户请求频率限制为 10 次/秒
超时时间：约为 5 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetResourceURL`	接口名称。当前 API 的名称为 `GetResourceURL`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
ServiceId	String	是	`8h**9q`	资源所在的服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。
Domain	String	是	`example.test.com`	域名。您可以通过调用 OpenAPI 获取服务下所有域名获取。
URI	String	是	`tos-i-xxxxx/test.png`	文件存储 Uri。您可以通过调用 OpenAPI 获取服务下的上传文件获取。
Tpl	String	否	`tplv-8h**9q-1.image`	模板名称，缺省情况下表示无模板处理图片。您可以通过调用 OpenAPI 获取服务下所有图片模板获取。注意若 `ServiceId` 的服务类型为图像处理服务，则 `Tpl` 为必填。若 `ServiceId` 的服务类型为素材托管服务，则 `Tpl` 为非必填。
Proto	String	否	`https`	协议，支持取值有： http（默认） https
Format	String	否	`image`	创建模板时设置的图片输出格式，默认为 image，支持取值有： image：表示输出原格式；静图格式：png、jpeg、heic、avif、webp; 动图格式：awebp、heif、avis。
Timestamp	Integer	否	`1800`	过期时长，最大限制为 1 年，默认为 1800s。说明仅当开启 URL 鉴权配置后，`Timestamp` 配置生效。

返回参数

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

参数	类型	示例值	描述
URL	String	`http://example.test.com/tos-i-xxxxx/test.png~tplv-8h**9q-1.image`	结果图访问默认地址。
CompactURL	String	`http://example.test.com/test.png~tplv-8h**9q-1.image`	结果图访问精简地址，与默认地址相比缺少 Bucket 部分。
ObjURL	String	`http://example.test.com/tos-i-xxxxx/test.png`	默认源文件访问地址。
ObjCompactURL	String	`http://example.test.com/test.png`	精简源文件地址，与默认地址相比缺少 Bucket 部分。

请求示例

获取存储于图像处理服务的源文件访问地址，以及经模板处理后的结果图访问地址。

GET https://imagex.volcengineapi.com/?Action=GetResourceURL&Version=2023-05-01&ServiceId=fr**3o&Domain=image.test.com&URI=tos-cn-i-fr**3o/preview.jpg&Format=image&Tpl=tplv-fr**3o-27

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetResourceURL",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "URL": "http://image.test.com/tos-cn-i-fr**3o/preview.jpg~tplv-fr**3o-27.image",
        "CompactURL": "http://image.test.com/preview.jpg~tplv-fr**3o-27.image",
        "ObjURL": "http://image.test.com/tos-cn-i-fr**3o/preview.jpg",
        "ObjCompactURL": "http://image.test.com/preview.jpg"
    }
}

错误码

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

服务端 SDK

为了方便您快速开发，veImageX 提供了配套的服务端 SDK，同时支持多种编程语言。建议您使用服务端 SDK 来调用 API，参考文档如下所示：

历史版本

2018-08-01 版本 GetResourceURL 接口文档现已停止维护，建议您参考本文档使用最新版本。