You need to enable JavaScript to run this app.
导航
应用型负载均衡
  • 文档首页
    • /应用型负载均衡/开发指南/API 参考/个性化配置接口/CreateCustomizedCfg
CreateCustomizedCfg
最近更新时间：2024.06.28 16:26:04首次发布时间：2022.07.07 14:48:16
我的收藏

请求说明

API 名称：CreateCustomizedCfg。
API 域名：open.volcengineapi.com。
API 描述：创建一个个性化配置，一个账号下每个区域最多可创建50个个性化配置。

使用限制

节流限制：每秒最多提交 10 个 API 请求。

调试

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

URI 参数

在使用该部分 API 提交请求时必须包含以下 URI 参数。

除了 URI 参数，该 API 请求还需要包含签名参数。关于更多签名参数的信息，参见公共请求参数 。

名称类型是否必选格式说明
Action
string
是
[a-zA-Z]+
API 名称，如 CreateCustomizedCfg 。
Versionstring是YYYY-MM-DDAPI 版本信息。该参数的取值是 2020-04-01 。
X-Expiresint否900表示签名的有效时间，单位是秒，默认值是900。

请求参数

在使用该 API 提交请求时，请求参数中可以包含的参数如下。

参数类型是否必选参数说明示例值
CustomizedCfgName
String
是

个性化配置的名字， 具体规则如下：

  • 不能以http://或https://开头。
  • 必须以字母或中文开头，可包含数字、点号（.）、下划线（_）和短横线（-）。
  • 长度限制为1 ～ 128个字符。
myCustomizedCfg

CustomizedCfgContent

String

是

个性化配置项内容，具体规则如下：

  • 长度不超过4096字符。

  • 空格和分号需要转义。

  • 不同的配置项之间通过";"分割，配置项不能重复。

  • 当前支持的配置项有ssl_protocols、ssl_ciphers、client_max_body_size、keepalive_timeout、proxy_request_buffering、proxy_connect_timeout、add_header、client_header_timeout、proxy_read_timeout、proxy_send_timeout、client_body_timeout、send_timeout和ssl_verify_depth。详细信息参见 个性化配置项内容。

client_max_body_size 60M
keepalive_timeout 75s

Description

String

否

个性化配置的描述。，具体规则如下：

  • 不能以http://或https://开头。
  • 必须以字母或中文开头，可包含数字、英文逗号（,）、点号（.）、下划线（_）、空格（ ）、等号（=）、短横线（-）、中文逗号（，）、中文句号（。）
  • 长度限制为1 ～ 255个字符。
  • 不填默认为空字符串。

This is a CustomizedCfg

ProjectNameString否个性化配置所属项目名称。default

个性化配置项内容

配置项

说明

取值范围

默认值

proxy_connect_timeoutupstream 后端连接超时间。4～120s4s
keepalive_timeoutClient-Server 长连接保持时间，设置为0则禁用长连接。0～900s75s

client_max_body_size

  • Client request body最大值 。

  • 超过256时，需要将proxy_request_buffering 设置为off。

1～30720M

60M

ssl_protocols

使用的TLS协议版本。默认选择 TLSv1、TLSv1.1、TLSv1.2 ，ALB支持白名单用户开启 TLSv1.3，如需体验，请提交工单。TLS协议版本具体规则如下：

  • 支持单选和多选，多选时协议版本必须连选。

  • 不支持配置重复的协议。

多选TLSv1 、TLSv1.1 、TLSv1.2 、TLSv1.3（白名单用户才可使用）

TLSv1 TLSv1.1 TLSv1.2

proxy_request_buffering

  • on： 表示缓存客户端请求体。全部接收完成后再分块转发给后端服务器。

  • off：表示不缓存客户端请求体。收到请求后，立即转发给后端服务器。

on或者off

on

ssl_ciphers

加密套件。多个加密套件使用":"分隔。

  • TLSv1.0和TLSv1.1 支持：

    • ECDHE-ECDSA-AES128-SHA

    • ECDHE-ECDSA-AES256-SHA

    • ECDHE-RSA-AES128-SHA

    • ECDHE-RSA-AES256-SHA

    • AES128-SHA

    • AES256-SHA

    • DES-CBC3-SHA

  • TLSv1.2支持：

    • ECDHE-ECDSA-AES128-SHA

    • ECDHE-ECDSA-AES256-SHA

    • ECDHE-RSA-AES128-SHA

    • ECDHE-RSA-AES256-SHA

    • AES128-SHA

    • AES256-SHA

    • DES-CBC3-SHA

    • ECDHE-ECDSA-AES128-GCM-SHA256

    • ECDHE-ECDSA-AES256-GCM-SHA384

    • ECDHE-ECDSA-AES128-SHA256

    • ECDHE-ECDSA-AES256-SHA384

    • ECDHE-RSA-AES128-GCM-SHA256

    • ECDHE-RSA-AES256-GCM-SHA384

    • ECDHE-RSA-AES128-SHA256

    • ECDHE-RSA-AES256-SHA384

    • AES128-GCM-SHA256

    • AES256-GCM-SHA384

    • AES128-SHA256

    • AES256-SHA256

ECDH+AESGCM:DH+AESGCM:ECDH+AES256:DH+AES256:ECDH+AES128:DH+AES:ECDH+3DES:DH+3DES:RSA+AESGCM:RSA+AES:RSA+3DES:!aNULL:!MD5

add_header

将指定的字段添加到响应报头中。具体规则如下：

  • header key

    • 由（_）、（-）、字母、数字组成的字符串。

    • 长度限制在 1~128 个字符之间。

    • key 不允许重复。

  • value

    • 由字母、数字、（_）、（-）、（*）、（,）（/）、（\）、（:）、（@）、（=）、（.）、英文括号、英文空格、英文单双引号组成的字符串。不能有（;）。

    • 引号只能出现在开始字符和末尾字符。

    • 带有数字、字母外的特殊字符，需要用引号括起来，如 "POST, OPTIONS"。

    • 长度限制在 1~128 个字符之间。

  • always

    • always是add_header的第3个参数，是一个可选项

    • 不开always：新增的自定义响应头，只会在响应码为200, 201, 204, 206, 301, 302, 303, 304, 307, 308 时带上（简称为2xx、3xx支持）

    • 开启always：新增的自定义响应头，所有响应码都会带上（2xx、3xx、4xx、5xx都支持）

  • 最多只能配置10个自定义header。

  • 允许跨域请求使用不同的方法

    • 自定义头部名称：Access-Control-Allow-Methods

    • 自定义头部值："POST, OPTIONS"

    • 如果希望在响应码为4xx、5xx时也能获取跨域的响应头，请开启always 。

  • 哪些域名的请求被允许接入ALB

    • 自定义头部名称：Access-Control-Allow-Origin

    • 自定义头部值：具体域名，填“*”时表示任意来源的请求都被允许接入ALB。

    • 如果希望在响应码为4xx、5xx时也能获取跨域的响应头，请开启always 。

-

client_header_timeout

  • 定义读取客户端请求头的超时时间。

  • 如果客户端在这段时间内没有传输整个报头，则将返回 408错误码给客户端，表示请求超时。

30-120s

60s

proxy_read_timeout

  • 定义 ALB 从后端服务器读取响应的超时时间。

  • 此超时时间仅针对两个连续的读操作之间设置，而不是整个响应的传输过程。

  • 如果后端服务器在该时间内未传输任何内容，则关闭连接。

30-3600s

60s

proxy_send_timeout

  • 定义 ALB 将请求传输到后端服务器的超时时间。

  • 此超时时间仅针对两个连续的写操作之间设置，而不是整个请求的传输过程。

  • 如果后端服务器在该时间内未收到任何内容，则关闭连接。

30-3600s

60s

client_body_timeout

  • 定义读取客户端请求参数的超时时间。

  • 此超时时间仅针对两个连续读操作之间的时间间隔设置，而不是整个请求的传输过程。

  • 如果客户端在这段时间内没有发送任何内容，则将返回 408错误码给客户端，表示请求超时。

30-120s

60s

send_timeout

  • 定义向客户端发送响应的超时时间。

  • 此超时时间仅针对两个连续的写入操作之间设置，而不是整个响应的传输过程。

  • 如果客户端在此时间内没有收到任何内容，则连接将被关闭。

1-3600s

60s

ssl_verify_depth定义客户端证书链的验证深度。3～103

ssl_session_timeout

  • 定义客户端保存 Session Ticket 的时间。

  • 过期后客户端将删除该 Ticket。

1-60分

10分

proxy_buffer_size设置接收后端响应的缓存区大小。4-32k4k

large_client_header_buffers

  • 设置用于读取大型客户端请求标头的缓存区的最大数量和大小。

  • 请求行不能超过一个缓存区的大小，否则会向客户端返回 414 错误。请求头字段不能超过一个缓存区的大小，否则会向客户端返回 400 错误。

最大数量输入范围：4-8。
大小输入范围：8-16k。

最大数量输入范围默认取值：4。
大小输入范围默认取值：8k。

more_set_input_headers

将指定的字段添加到请求报头中。具体规则如下：

  • header key

    • 由（_）、（-）、字母、数字组成的字符串。

    • 长度不超过128字符。

    • 不支持以（-）开头。

    • 不允许重复。

  • value

    • 只能是变量或者其他字符串。

    • 由字母、数字、（_）、（-）、（*）、（,）（/）、（@）、（=）、（.）、英文括号、空格、单引号组成的字符串。不能有（;）。

    • 引号只能出现在开始字符和末尾字符。

    • 首尾不能出现空格。

    • 长度不超过128字符。

  • 最多只能配置10个自定义header。

  • header key 不区分大小写。不支持： x-real-ip，x-forwarded-for，x-forwarded-proto，x-alb-waf-requestid，x-alb-waf-real-port，upgrade，connection，x-vport，x-vip，x-real-ip，x-clb-cluster，x-toutiao-lb-ip，x-vni，content-length，transfer-encoding，keep-alive，host，cookie，authority。

  • 当 value 是变量，支持 $remote_addr，$proxy_add_x_forwarded_for，$remote_port，$scheme， $vport，$load_balancer_id

-

返回参数

参数类型参数说明示例值
RequestId
String
请求ID。
20210811152539010225146063030****
CustomizedCfgIdString个性化配置 ID 。ccfg-3cj44nv0jhhxc6c6rrtet****

示例

请求示例

GET /?Action=CreateCustomizedCfg&CustomizedCfgName=test-1&Description=test&CustomizedCfgContent=client_max_body_size%2060M%3Bkeepalive_timeout%2075s%3B&ProjectName=default&Version=2020-04-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: alb

返回示例

{
    "ResponseMetadata":{
        "RequestId": "0cd0297c-9a88-48cb-9ba2-82c3dcbc****",
        "Action": "CreateCustomizedCfg",
        "Version": "2020-04-01",
        "Service": "alb",
        "Region": "cn-beijing"
    },
    "Result":{
        "RequestId": "0cd0297c-9a88-48cb-9ba2-82c3dcbc****",
        "CustomizedCfgID": "ccfg-3lk5o0tulupdswet340b****"
    }
}

错误码

如果响应正文包含 Error 字段，则表示 API 请求失败。此处仅展示当前 API 的错误码，更多错误码请参见公共错误码。

HTTP Code错误码错误信息错误描述

400

InvalidCustomizedCfgName.Malformed

The specified CustomizedCfgName is malformed.

指定的 CustomizedCfgName 参数格式不合法。

400InvalidDescription.MalformedThe specified Description is malformed.指定的 Description 参数格式不合法。

400

MissingParameter

The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, 'CustomizedCfgContent'.

该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如: CustomizedCfgContent。

400

InvalidCustomizedCfgContent.Malformed

The specified CustomizedCfgContent is malformed.

指定的 CustomizedCfgContent 参数格式不合法。

400

InvalidCustomizedCfgContent.Malformed

The specified CustomizedCfgContent is malformed. proxy_connect_timeout config in CustomizedCfgContent is invalid.

指定的 CustomizedCfgContent 参数格式不合法。其中的 proxy_connect_timeout 配置不合法。

400InvalidCustomizedCfgContent.MalformedThe specified CustomizedCfgContent is malformed. keepalive_timeout config in CustomizedCfgContent is invalid.指定的 CustomizedCfgContent 参数格式不合法。其中的 keepalive_timeout 配置不合法。
400InvalidCustomizedCfgContent.MalformedThe specified CustomizedCfgContent is malformed. ssl_protocols config in CustomizedCfgContent is invalid.指定的 CustomizedCfgContent 参数格式不合法。其中的 ssl_protocols 配置不合法。

400

InvalidCustomizedCfgContent.Malformed

The specified CustomizedCfgContent is malformed. proxy_request_buffering config in CustomizedCfgContent is invalid.

指定的 CustomizedCfgContent 参数格式不合法。其中的 proxy_request_buffering 配置不合法。

400InvalidCustomizedCfgContent.MalformedThe specified CustomizedCfgContent is malformed. ssl_verify_depth config in CustomizedCfgContent is invalid.指定的 CustomizedCfgContent 参数格式不合法。其中的 ssl_verify_depth 配置不合法。
400InvalidCustomizedCfgContent.MalformedThe specified CustomizedCfgContent is malformed. send_timeout config in CustomizedCfgContent is invalid.指定的 CustomizedCfgContent 参数格式不合法。其中的 send_timeout 配置不合法。

400

InvalidCustomizedCfgContent.Malformed

The specified CustomizedCfgContent is malformed. client_body_timeout config in CustomizedCfgContent is invalid.

指定的 CustomizedCfgContent 参数格式不合法。其中的 client_body_timeout 配置不合法。

400InvalidCustomizedCfgContent.MalformedThe specified CustomizedCfgContent is malformed. proxy_send_timeout config in CustomizedCfgContent is invalid.指定的 CustomizedCfgContent 参数格式不合法。其中的 proxy_send_timeout 配置不合法。
400InvalidCustomizedCfgContent.MalformedThe specified CustomizedCfgContent is malformed. proxy_read_timeout config in CustomizedCfgContent is invalid.指定的 CustomizedCfgContent 参数格式不合法。其中的 proxy_read_timeout 配置不合法。
400InvalidCustomizedCfgContent.MalformedThe specified CustomizedCfgContent is malformed. client_header_timeout config in CustomizedCfgContent is invalid.指定的 CustomizedCfgContent 参数格式不合法。其中的 client_header_timeout 配置不合法。

400

InvalidCustomizedCfgContent.Malformed

The specified CustomizedCfgContent is malformed. add_header config in CustomizedCfgContent is invalid.

指定的 CustomizedCfgContent 参数格式不合法。其中的 add_header 配置不合法。

400

InvalidCustomizedCfgContent.Malformed

The specified CustomizedCfgContent is malformed. add_header config in CustomizedCfgContent is invalid, the number of add_header exceeds limit.

指定的 CustomizedCfgContent 参数格式不合法。其中的 add_header 配置不合法，数量超出限制。

400

InvalidCustomizedCfgContent.Malformed

The specified CustomizedCfgContent is malformed. ssl_ciphers config in CustomizedCfgContent is invalid.

指定的 CustomizedCfgContent 参数格式不合法。其中的 ssl_ciphers 配置不合法。

400InvalidCustomizedCfgContent.MalformedThe specified CustomizedCfgContent is malformed. client_max_body_size config in CustomizedCfgContent is invalid.指定的 CustomizedCfgContent 参数格式不合法。其中的 client_max_body_size 配置不合法。

400

InvalidCustomizedCfgContent.Malformed

The specified CustomizedCfgContent is malformed. ssl_session_timeout config in CustomizedCfgContent is invalid.

指定的 CustomizedCfgContent 参数格式不合法。其中的 ssl_session_timeout 配置不合法。

400OperationFailed.QueryProjectThe request on the specified resource failed due to the query on project failed.因查询项目失败，对于该资源的操作请求失败。

400

QuotaExceed.CustomizedCfgPerRegion

You've reached the limit on the number of CustomizedCfgs the current region you can create in, usage xx/xx.

已达到当前地域可创建的个性化配置的数量上限。目前已使用xxx，配额为xxx。

400

OperationFailed.AddIntoProjectFailed

The request on the specified resource failed due to adding it into the project failed.

因将资源加入至项目中失败，对于该资源的操作请求失败。

400

InvalidCustomizedCfgContent.Duplicated

The specified CustomizedCfgContent is duplicated. proxy_connect_timeout config in CustomizedCfgContent is duplicated.

指定的 CustomizedCfgContent 重复。其中的 proxy_connect_timeout 配置项重复。

400

InvalidCustomizedCfgContent.Duplicated

The specified CustomizedCfgContent is duplicated. keepalive_timeout config in CustomizedCfgContent is duplicated.

指定的 CustomizedCfgContent 重复。其中的 keepalive_timeout 配置项重复。

400

InvalidCustomizedCfgContent.Duplicated

The specified CustomizedCfgContent is duplicated. client_max_body_size config in CustomizedCfgContent is duplicated.

指定的 CustomizedCfgContent 重复。其中的 client_max_body_size 配置项重复。

400InvalidCustomizedCfgContent.DuplicatedThe specified CustomizedCfgContent is duplicated. ssl_protocols config in CustomizedCfgContent is duplicated.指定的 CustomizedCfgContent 重复。其中的 ssl_protocols 配置项重复。

400

InvalidCustomizedCfgContent.Duplicated

The specified CustomizedCfgContent is duplicated. proxy_request_buffering config in CustomizedCfgContent is duplicated.

指定的 CustomizedCfgContent 重复。其中的 proxy_request_buffering 配置项重复。

400

InvalidCustomizedCfgContent.Duplicated

The specified CustomizedCfgContent is duplicated. ssl_ciphers config in CustomizedCfgContent is duplicated.

指定的 CustomizedCfgContent 重复。其中的 ssl_ciphers 配置项重复。

400

InvalidCustomizedCfgContent.Duplicated

The specified CustomizedCfgContent is duplicated. ssl_verify_depth config in CustomizedCfgContent is duplicated.

指定的 CustomizedCfgContent 重复。其中的 ssl_verify_depth 配置项重复。

400

InvalidCustomizedCfgContent.Duplicated

The specified CustomizedCfgContent is duplicated. send_timeout config in CustomizedCfgContent is duplicated.

指定的 CustomizedCfgContent 重复。其中的 send_timeout 配置项重复。

400

InvalidCustomizedCfgContent.Duplicated

The specified CustomizedCfgContent is duplicated. client_body_timeout config in CustomizedCfgContent is duplicated.

指定的 CustomizedCfgContent 重复。其中的 client_body_timeout 配置项重复。

400

InvalidCustomizedCfgContent.Duplicated

The specified CustomizedCfgContent is duplicated. proxy_send_timeout config in CustomizedCfgContent is duplicated.

指定的 CustomizedCfgContent 重复。其中的 proxy_send_timeout 配置项重复。

400

InvalidCustomizedCfgContent.Duplicated

The specified CustomizedCfgContent is duplicated. proxy_read_timeout config in CustomizedCfgContent is duplicated.

指定的 CustomizedCfgContent 重复。其中的 proxy_read_timeout 配置项重复。

400

InvalidCustomizedCfgContent.Duplicated

The specified CustomizedCfgContent is duplicated. client_header_timeout config in CustomizedCfgContent is duplicated.

指定的 CustomizedCfgContent 重复。其中的 client_header_timeout 配置项重复。

400

InvalidCustomizedCfgContent.Duplicated

The specified CustomizedCfgContent is duplicated. ssl_session_timeout config in CustomizedCfgContent is duplicated.

指定的 CustomizedCfgContent 重复。其中的 ssl_session_timeout 配置项重复。

404InvalidProject.NotFoundThe specified Project does not exist.指定的项目不存在。