获取常用颜色--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

获取常用颜色

最近更新时间：2024.08.05 18:26:09首次发布时间：2022.07.20 11:00:07

获取当前颜色列表内的所有颜色。

说明

该接口属于历史版本 API，建议您使用新版 GetImageBackgroundColors 接口。

请求说明

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

说明

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

请求参数

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

Query

参数	类型	是否必选	描述
Action	String	是	接口名称。
Version	String	是	接口版本。veImageX 当前 API 的版本为 `2018-08-01`。

返回参数

参数	类型	描述
Colors	Array of String	颜色列表。

示例

请求示例

GET https://imagex.volcengineapi.com/?imagex-lang=zh&Action=GetImageBackgroundColors&Version=2018-08-01

正常返回示例

{
   "ResponseMetadata":{
      "RequestId":"2022071815274301020801714002AEAE2C",
      "Action":"GetImageBackgroundColors",
      "Version":"2018-08-01",
      "Service":"imagex",
      "Region":"cn-north-1"
   },
   "Result":{
      "Colors":[
         "#EE5C3D",
         "#E55D8F",
         "#bddcbe",
         "#00000000",
         "#C9CDD4",
         "#FFA841"
      ]
   }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022071815274301020801714002AEAE2C",
        "Action": "GetImageBackgroundColors",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
             "Code": "xx",
            "Message": "xx"
        }
    }
}

错误码

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