获取常用图片/背景/蒙版要素--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

获取常用图片/背景/蒙版要素

最近更新时间：2024.09.03 16:47:46首次发布时间：2024.04.19 11:39:02

在要素列表通过指定要查询的要素类型（图片/背景/蒙版），获取当前已添加为常用的该类型要素详情（如 URI 和添加时间等）。

注意事项

请求频率：单用户请求频率限制为 5 次/秒。
超时时间：约为 10 秒。
服务地址：仅支持使用国内对应的 OpenAPI 域名，具体请见请求地址。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetImageElements`	接口名称。当前 API 的名称为 `GetImageElements`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
Type	String	是	`image`	要素类型，取值如下所示： `image`：图片要素 `background`：背景要素 `mask`：蒙版要素
SearchPtn	String	否	`mofang`	返回图片 URI 中包含该值的要素列表。
Limit	String	否	`10`	分页返回条数。默认 10，最大限制为 100。
Offset	String	否	`0`	分页偏移，默认 0，取值为 1 时，表示跳过一条数据，从第二条数据取值。

返回参数

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

参数	类型	示例值	描述
Total	Float	`2`	要素总个数。
ImageList	Array of ImageList	`-`	要素列表。

ImageList

参数	类型	示例值	描述
StoreUri	String	`tos-cn-i-nnsl1jf0m*/mofang/16e5f344e12363fa463d619be5bcbece.png`	要素存储 URI。
AddAt	String	`2022-07-15 16:50:30`	要素添加时间，添加要素时的服务器当地时间。

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageElements&Version=2023-05-01&Type=image&SearchPtn=mofang&Limit=10&Offset=0

返回示例

{
  "ResponseMetadata": {
    "RequestId": "2022071814510401021117309801FD1D15",
    "Action": "GetImageElements",
    "Version": "2023-05-01",
    "Service": "imagex",
    "Region": "cn-north-1"
  },
  "Result": {
    "Total": 2,
    "ImageList": [
      {
        "StoreUri": "tos-cn-i-nnsl1jf0m*/mofang/16e5f344e12363fa463d619be5bcbece.png",
        "AddAt": "2022-07-15 16:50:30"
      },
      {
        "StoreUri": "tos-cn-i-ldojp2yol*/mofang/779a640e6f743ecc910c5331140fa654.jpeg",
        "AddAt": "2022-04-13 16:13:29"
      }
    ]
  }
}

错误码

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

历史版本

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