文档中心

获取资源URL

最近更新时间：2024.01.31 15:12:57

首次发布时间：2022.09.19 17:13:00

支持指定服务 ID 、域名以及上传图像资源 Uri 后，获取资源访问地址；若指定模板，也支持获取模板处理后结果图访问地址。

请求说明

接口名称：GetResourceURL
请求方式：GET
接口地址示例：https://imagex.volcengineapi.com/?Action=GetResourceURL&Version=2018-08-01
请求频率限制：10 次/秒
超时时间：5 秒

说明

veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

Query

参数	类型	是否必选	描述
Action	String	是	接口名称。
Version	String	是	接口版本。veImageX 当前 API 的版本为 2018-08-01。
ServiceId	String	是	服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。
Domain	String	是	域名。您可以通过调用 OpenAPI 获取服务下所有域名查看 domain 返回值。
URI	String	是	图片资源 Uri。您可以通过调用 OpenAPI 获取文件上传成功信息查看 ImageUri 返回值。
Tpl	String	否	模板名称。缺省情况下表示无模板处理图片。您可以通过调用 OpenAPI 获取服务下所有图片模板里查看 TemplateName 返回值。
Proto	String	否	协议，默认为 http，隐私图片使用 https，公开图片支持取值 http 以及 https。
Format	String	否	创建模板时设置的图片输出格式，默认为 iamge，支持取值有： image：表示输出原格式；静图格式：png、jpeg、heic、avif、webp; 动图格式：awebp、heif、avis。
Timestamp	String	否	过期时长，最大限制为 1 年，默认1800s。

返回参数

参数	类型	描述
URL	String	结果图访问默认地址。
CompactURL	String	结果图访问精简地址，与默认地址相比缺少 Bucket 部分。
ObjURL	String	默认源图片地址。
ObjCompactURL	String	精简源图片地址，与默认地址相比缺少 Bucket 部分。

示例

请求示例

GET https://imagex.volcengineapi.com/?Action=GetResourceURL&Version=2018-08-01&ServiceId=ro**vb&Domain=test.volcimagex.cn&URI=tos-boe-i-ro**vb/test.jpeg&Format=image&Tpl=tplv-ro**vb

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "202209081106590102252431250087BD7B",
        "Action": "GetResourceURL",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "url": "http://test.volcimagex.cn/tos-boe-i-ro**vb/test.jpeg~tplv-ro**vb.image",
        "compact_url": "http://test.volcimagex.cn/test.jpeg~tplv-ro**vb.image",
        "obj_url": "http://test.volcimagex.cn/tos-boe-i-ro**vb/test.jpeg",
        "obj_compact_url": "http://test.volcimagex.cn/test.jpeg"
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022090811234901017423503806E63501",
        "Action": "GetResourceURL",
        "Version": "2018-08-01"
        "Service": "imagex",
        "Region": "cn-north-1"
        "Error": {
            "CodeN": 603001,
            "Code": "",
            "Message": "模板未找到",
        }
    },
}

错误码

访问公共错误码获取详细信息。