添加常用颜色--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

添加常用颜色

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

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

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`AddImageBackgroundColors`	接口名称。当前 API 的名称为 `AddImageBackgroundColors`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。

Body

参数	类型	是否必选	示例值	描述
Colors	Array of String	是	`["#EE5C3D","#E55D8F","#bddcbe","#00000000","#C9CDD4","#FFA841"]`	待添加的颜色列表，支持 RGB/RGBA 值。

返回参数

参数	类型	示例值	描述
FailedList	Array of String	`["#EE5C3D"]`	添加失败的颜色列表。若全部添加失败，则接口将返回失败。

请求示例

POST https://imagex.volcengineapi.com/?Action=AddImageBackgroundColors&Version=2023-05-01
{
    "Colors":[
         "#EE5C3D",
         "#E55D8F",
         "#bddcbe",
         "#00000000",
         "#C9CDD4",
         "#FFA841"
      ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "AddImageBackgroundColors",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "FailedList": [
            "#EE5C3D"
        ]
    }
}

错误码

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

历史版本

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