管理图片 EXIF 数据--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

管理图片 EXIF 数据

最近更新时间：2024.09.13 14:50:39首次发布时间：2024.09.04 11:16:38

本接口支持同步新增、删除和修改 JPEG/PNG/WEBP/HEIC/AVIF 格式的静图 EXIF 数据。

说明

您可参考查询图片 meta 信息，获取图片中存在的 EXIF 信息。

使用说明

EXIF 数据中包含了各种不同的信息，这些信息通常以 Tag 的形式存在。每个 Tag 都对应着特定的属性或元数据，例如拍摄日期、相机型号、曝光时间等。由于创建 EXIF 时会有一些默认值，在新增一个 Tag 时可能会引发其他 Tag 的出现或变化。

本接口支持处理的 EXIF 数据如下所示，各 Tag 的详细说明请参考 Standard Exif Tags。

Tag 名称	含义	传值示例
ImageWidth	图片宽	`"100"`
ImageLength	图片高	`"100"`
ResolutionUnit	分辨率单位	`"2"`
XResolution	X 方向分辨率	`"72/1"`
YResolution	Y 方向分辨率	`"72/1"`
Orientation	旋转分量	`"6"`
ExposureTime	曝光时间	`"10/1000"`或`"0.001"`
ExposureProgram	曝光程序	`"1"`
Flash	闪光	`"9"`
UserComment	自定义信息，一般为字符串	`"generated_by_ai"`
Make	设备生产商	`"xiaomi"`
Model	设备名字	`"MI 6X"`
Software	相机型号	`"wayne-user 8.1.0 OPM1.171019.011 V10.0.2.0.ODCCNFH release-keys"`
Artist	拍摄者	`"Test"`
Copyright	版权信息	`"Copyright, Test. All rights reserved."`
DateTime	文件创建时间，需遵循 `YYYY:MM:DD HH:MM:SS` 的时间格式。	`"2024:01:01 08:00:00"`
DateTimeDigitized	照片数字化存储时间，需遵循 `YYYY:MM:DD HH:MM:SS` 的时间格式。	`"2024:01:01 08:00:00"`
DateTimeOriginal	照片生成时间，需遵循 `YYYY:MM:DD HH:MM:SS` 的时间格式。	`"2024:01:01 08:00:00"`
GPSLatitudeRef	纬度方向	`"N"`或`"S"`
GPSLatitude	纬度（度/分/秒）	`"10.3444"`或`"10/1 20/1 40/1"`
GPSLongitudeRef	经度方向	`"E"`或`"W"`
GPSLongitude	经度（度/分/秒）	`"10.3444"`或`"10/1 20/1 40/1"`
GPSAltitudeRef	高度方向	`"0"`或`"1"`
GPSAltitude	高度	`"10/1"`或`"20.45"`

注意事项

原图限制：仅支持 JPEG、PNG、WEBP、HEIC 和 AVIF 格式的静图，其他大小或分辨率限制请参考图片处理限制说明。
超时时间：15 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述

Action String 是 UpdateImageExifData 接口名称。当前 API 的名称为 UpdateImageExifData。

Version String 是 2023-05-01 接口版本。当前 API 的版本为 2023-05-01。

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateImageExifData`	接口名称。当前 API 的名称为 `UpdateImageExifData`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
ServiceId	String	是	`8h**01`	待修改图片所在的服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

ServiceId

String

是

8h**01

待修改图片所在的服务 ID。

您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。
您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。

Body

参数类型是否必选示例值描述

StoreUri String 是 tos-cn-i-8h**01/old_key.png 原图存储 URI。您可以通过调用获取服务下的上传文件来获取所需的图片存储 URI。

参数	类型	是否必选	示例值	描述
StoreUri	String	是	`tos-cn-i-8h**01/old_key.png`	原图存储 URI。您可以通过调用获取服务下的上传文件来获取所需的图片存储 URI。
DstKey	String	否	`new_key`	指定修改后图片的文件名。最大长度限制为 180 个字节，不传则随机生成一个文件名。输入限制如下所示：不支持空格，如果中间有空格将会导致重命名失败。不支持以/开头或结尾，不支持/连续出现。注意若指定的文件名已存在，那么当在服务维度开启重名覆盖上传时，将覆盖原文件，否则接口将返回失败。
Actions	Array of Actions	是	`-`	指定图片的处理操作，最多支持填写 50 条。

DstKey

String

否

new_key

指定修改后图片的文件名。最大长度限制为 180 个字节，不传则随机生成一个文件名。输入限制如下所示：

不支持空格，如果中间有空格将会导致重命名失败。
不支持以/开头或结尾，不支持/连续出现。

注意

若指定的文件名已存在，那么当在服务维度开启重名覆盖上传时，将覆盖原文件，否则接口将返回失败。

Actions Array of Actions 是 - 指定图片的处理操作，最多支持填写 50 条。

Actions

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
Type	String	是	`Modify`	指定图片的处理类型，取值如下所示： `Delete`：删除指定 Tag 的内容 `DeleteAll`：删除所有 Tag 的内容 `Modify`：修改指定 Tag 的内容
TagName	String	否	`tag1`	仅当 `Type` 取值为 `Delete/Modify` 时，为必填。指定要处理的 Tag 名称，仅支持对列表内的标签进行处理。
TagValue	String	否	`val1`	仅当 `Type` 取值为 `Modify` 时，为必填。指定新增/修改后 Tag 的内容，最大为 1024 字节。说明若原图中 `TagName` 内容为空，则表示新增内容；若原图中 `TagName` 存在已有内容，则表示更新内容。

Type

String

是

Modify

指定图片的处理类型，取值如下所示：

Delete：删除指定 Tag 的内容
DeleteAll：删除所有 Tag 的内容
Modify：修改指定 Tag 的内容

TagName

String

否

tag1

仅当 Type 取值为 Delete/Modify 时，为必填。
指定要处理的 Tag 名称，仅支持对列表内的标签进行处理。

TagValue

String

否

val1

仅当 Type 取值为 Modify 时，为必填。
指定新增/修改后 Tag 的内容，最大为 1024 字节。

说明

若原图中 TagName 内容为空，则表示新增内容；
若原图中 TagName 存在已有内容，则表示更新内容。

返回参数

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

参数	类型	示例值	描述
DstUri	String	`tos-cn-i-8h**01/new_key`	处理成功后图片的存储 URI。

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateImageExifData&Version=2023-05-01&ServiceId=8h**01
{
    "StoreUri": "tos-cn-i-8h**01/old_key.png",
    "Actions": [
        {
            "Type": "Delete",
            "TagName": "Orientation"
        },
        {
            "Type": "DeleteAll",
        },
        {
            "Type": "Modify", 
            "TagName": "UserComment",
            "TagValue": "test"
        }
    ],
    "DstKey": "new_key"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateImageExifData",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "DstUri": "tos-cn-i-8h**01/new_key"
    }
}

错误码

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

服务端 SDK

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