文档中心

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

最近更新时间：2024.01.31 15:20:01

首次发布时间：2022.07.20 11:14:33

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

请求说明

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

说明

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

请求参数

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

Query

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

返回参数

参数	类型	描述
Total	Integer	要素总个数。
ImageList	Array of ImageList	要素列表。

ImageList

参数	类型	描述
StoreUri	String	图片 URI。
AddAt	String	要素添加时间，添加要素时的服务器当地时间。

示例

请求示例

GET https://imagex.volcengineapi.com/?imagex-lang=zh&Action=GetImageElements&Version=2018-08-01&Type=image&SearchPtn=&Offset=0&Limit=20

正常返回示例

{
   "ResponseMetadata":{
      "RequestId":"2022071814510401021117309801FD1D15",
      "Action":"GetImageElements",
      "Version":"2018-08-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"
         }
      ]
   }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022071814510401021117309801FD1D15",
        "Action": "GetImageElements",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
             "Code": "xx",
            "Message": "xx"
        }
    }
}

错误码

访问公共错误码和创意魔方错误码获取详细信息。