文档中心

获取常用颜色

最近更新时间：2024.04.19 11:39:02

首次发布时间：2024.04.19 11:39:02

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

注意事项

请求频率：单用户请求频率限制为 5 次/秒。
超时时间：约为 10 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 openAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

Query

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

返回参数

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

参数	类型	示例值	描述
Colors	Array of String	`["#EE5C3D","#E55D8F","#bddcbe","#00000000","#C9CDD4","#FFA841"]`	颜色列表。

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageBackgroundColors&Version=2023-05-01

返回示例

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

错误码

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