文档中心

添加常用颜色

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

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

通过输入待添加的常用颜色（RGB/RGBA 值），在颜色列表内添加对应的颜色。

请求说明

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

说明

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

请求参数

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

Query

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

Body

参数	类型	是否必填	描述
Colors	Array of String	是	待添加的颜色列表。以 # 开始，后面跟 RGB 的十六进制值。传 6 位 HEX 代表 RGB 值，默认不透明。传 8 位 HEX 代表 RGBA 值，默认白色。

参数

类型

是否必填

描述

Colors

Array of String

是

待添加的颜色列表。以 # 开始，后面跟 RGB 的十六进制值。

传 6 位 HEX 代表 RGB 值，默认不透明。
传 8 位 HEX 代表 RGBA 值，默认白色。

返回参数

参数	类型	描述
FailedList	Array of String	添加失败的颜色列表。若全部添加失败，则接口将返回失败。

示例

请求示例

POST https://imagex.volcengineapi.com?Action=AddImageBackgroundColors&Version=2018-08-01
{
   "Colors":[
      "#FFA841"
   ]
}

正常返回示例

{
   "ResponseMetadata":{
      "RequestId":"2022071513305401021204519717A8DFCF",
      "Action":"AddImageBackgroundColors",
      "Version":"2018-08-01",
      "Service":"imagex",
      "Region":"cn-north-1"
   },
   "Result":{
   "FailedList":[    
      ]
   }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022071513305401021204519717A8DFCF",
        "Action": "AddImageBackgroundColors",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
             "Code": "xx",
            "Message": "xx"
        }
    }
}

错误码

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