自定义可查询的 meta 字段--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

自定义可查询的 meta 字段

最近更新时间：2025.12.17 17:43:42首次发布时间：2025.12.17 17:43:42

调用 UpdateImageInfoKey 接口，自定义可查询的 meta 字段，仅获取所需的图片元信息。

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

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

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

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateImageInfoKey`	接口名称。当前 API 的名称为 `UpdateImageInfoKey`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
ServiceId	String	是	`91**2g`	服务 ID。可通过以下任一方式获取。在服务管理页面，获取服务 ID。调用 GetAllImageServices 接口，获取服务 ID。

ServiceId

String

是

91**2g

服务 ID。可通过以下任一方式获取。

在服务管理页面，获取服务 ID。
调用 GetAllImageServices 接口，获取服务 ID。

Body

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

参数	类型	是否必选	示例值	描述
Type	String	是	`DropPart`	类型。传空值表示不自定义可查询的 meta 字段，即保留全部字段。取值如下： `ReserveAll`：保留全部字段。 `DropAll`：排除全部字段。 `ReservePart`：保留部分字段。 `DropPart`：排除部分字段。
Keys	Array of String	是	`["width","exif","aigc.Label"]`	需保留或排除的字段名称。支持一级和二级字段，例如 `["width","exif","aigc.Label"]`，其中 `width`、`exif` 为一级字段，`aigc.Label` 为二级字段。具体字段名称详见查询图片 meta 信息。说明仅当 `Type` 取值为 `ReservePart` 或 `DropPart` 时生效。

Type

String

是

DropPart

类型。传空值表示不自定义可查询的 meta 字段，即保留全部字段。取值如下：

ReserveAll：保留全部字段。
DropAll：排除全部字段。
ReservePart：保留部分字段。
DropPart：排除部分字段。

Keys

Array of String

是

["width","exif","aigc.Label"]

需保留或排除的字段名称。支持一级和二级字段，例如 ["width","exif","aigc.Label"]，其中 width、exif 为一级字段，aigc.Label 为二级字段。具体字段名称详见查询图片 meta 信息。

说明

仅当 Type 取值为 ReservePart 或 DropPart 时生效。

返回参数

本接口暂无特定的返回参数。更多信息请见公共返回参数。

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateImageInfoKey&Version=2023-05-01&ServiceId=91**2g
{
    "Type": "DropPart",
    "Keys": [
        "width",
        "exif",
        "aigc.Label"
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateImageInfoKey",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    }
}

错误码

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