## 请求说明 API 名称：CreateCustomizedCfg API 描述：创建一个个性化配置，一个账号下每个区域最多可创建50个个性化配置。 ## 使用限制节流限制：每秒最多提交 10 个 API 请求。 ## 调试 ## **URI 参数** 在使用该部分 API 提交请求时必须包含以下 URI 参数。 > 除了 URI 参数，该 API 请求还需要包含签名参数。关于更多签名参数的信息，参见[公共请求参数](../6406/113575) 。 |**名称** |**类型** |**是否必选** |**格式** |**说明** | |---|---|---|---|---| | | | | | |\ |Action |string |是 |[a\-zA\-Z]+ |API 名称，如 CreateCustomizedCfg 。 | |Version |string |是 |YYYY\-MM\-DD |API 版本信息。该参数的取值是 2020\-04\-01 。 | |X\-Expires |int |否 |900 |表示签名的有效时间，单位是秒，默认值是900。 | ## 请求参数在使用该 API 提交请求时，请求参数中可以包含的参数如下。 |**参数** |**类型** |**是否必选** |**参数说明** |**示例值** | |---|---|---|---|---| | | | |个性化配置的名字，具体规则如下：| |\ |CustomizedCfgName |String |是 ||myCustomizedCfg |\ | | | |* 不能以http://或https://开头。| |\ | | | |* 必须以字母或中文开头，可包含数字、点号（.）、下划线（_）和短横线（\-）。| |\ | | | |* 长度限制为1 ～ 128个字符。 | | |CustomizedCfgContent |String |是 |个性化配置项内容，具体规则如下：|client_max_body_size 60M|\ | | | ||keepalive_timeout 75s |\ | | | |* 长度不超过4096字符。| |\ | | | |* 空格和分号需要转义。| |\ | | | |* 不同的配置项之间通过";\r\n"分隔，配置项不能重复。| |\ | | | |* 当前支持的配置项有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。详细信息参见 [个性化配置项内容](#.5Liq5oCn5YyW6YWN572u6aG55YaF5a65)。 | | |Description |String |否 |个性化配置的描述。，具体规则如下：|This is a CustomizedCfg |\ | | | || |\ | | | |* 不能以http://或https://开头。| |\ | | | |* 必须以字母或中文开头，可包含数字、英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、短横线（\-）、中文逗号（，）、中文句号（。）| |\ | | | |* 长度限制为1 ～ 255个字符。| |\ | | | |* 不填默认为空字符串。 | | |ProjectName |String |否 |个性化配置所属项目名称。 |default | |Tags |Array |否 |个性化配置关联的标签，具体参见下表 [Tags](#Tags)。 | | **Tags** |参数 |类型 |是否必选 |参数说明 |示例值 | |---|---|---|---|---| |Tags.N.Key |String |是 |用户标签的标签键。具体规则如下：|Tags.1.Key=k1&Tags.2.Key=k2 |\ | | | || |\ | | | |* 长度限制为1～128个字符。| |\ | | | |* 大小写敏感。| |\ | | | |* 不能以volc:和sys:的任意大小写组合开头。| |\ | | | |* 不能以空格开头或结尾。| |\ | | | |* 允许包含各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（\-）和@。| |\ | | | |* 同一资源的标签键不允许重复。 | | |Tags.N.Value |String |否 |用户标签的标签值。如果传入该参数，则必须先传入Tags.N.Key。具体规则如下：|Tags.1.Value=v1&Tags.2.Value=v2 |\ | | | || |\ | | | |* 长度限制为0～256个字符。| |\ | | | |* 大小写敏感。| |\ | | | |* 不能以空格开头或结尾。| |\ | | | |* 允许包含各国语言文字、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（\-）和@。 | | **个性化配置项内容** |**配置项** |**说明** |**取值范围** |**默认值** | |---|---|---|---| |proxy_connect_timeout |upstream 后端连接超时间。 |4～120s |4s | |keepalive_timeout |Client\-Server 长连接保持时间，设置为0则禁用长连接。 |0～900s |75s | |client_max_body_size |* Client request body最大值。|1～30720M |60M |\ | |* 超过256时，需要将proxy_request_buffering 设置为off。 | | | |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：表示缓存客户端请求体。全部接收完成后再分块转发给后端服务器。|on或者off |on |\ | |* off：表示不缓存客户端请求体。收到请求后，立即转发给后端服务器。 | | | |ssl_ciphers |加密套件。多个加密套件使用":"分隔。 |* TLSv1.0和TLSv1.1 支持：|ECDH+AESGCM:DH+AESGCM:ECDH+AES256:DH+AES256:ECDH+AES128:DH+AES:ECDH+3DES:DH+3DES:RSA+AESGCM:RSA+AES:RSA+3DES:!aNULL:!MD5 |\ | | | * 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 | | |add_header |将指定的字段添加到响应报头中。具体规则如下：|典型场景的配置说明：|\- |\ | ||| |\ | |* header key|* 允许跨域请求使用不同的方法| |\ | | * 只能包含英文字母、数字、下划线（_）和短横线（\-）。| * 自定义头部名称：Access\-Control\-Allow\-Methods| |\ | | * 长度限制在 1~128 个字符之间。| * 自定义头部值："POST, OPTIONS"| |\ | | * key 不允许重复。| * 如果希望在响应码为4xx、5xx时也能获取跨域的响应头，请指定always参数。| |\ | |* value|* 哪些域名的请求被允许接入ALB| |\ | | * 只能包含英文字母、数字、空格和以下特殊字符：_ \- \* , / \ : @ = . ( ) ;。| * 自定义头部名称：Access\-Control\-Allow\-Origin| |\ | | * 带有数字、字母外的特殊字符，需要用双引号（"）或单引号（'）将整个头部值包裹起来，如 "POST, OPTIONS"。| * 自定义头部值：具体域名，填“\*”时表示任意来源的请求都被允许接入ALB。| |\ | | * 长度限制在 1~128 个字符之间。| * 如果希望在响应码为4xx、5xx时也能获取跨域的响应头，请指定always参数。| |\ | | * 不允许包含 "\r" 和 "\n"。|| |\ | |* always|配置示例：| |\ | | * always是add_header的第3个参数，是一个可选项|| |\ | | * 携带always参数：新增的自定义响应头，只会在响应码为200, 201, 204, 206, 301, 302, 303, 304, 307, 308 时带上（简称为2xx、3xx支持）|* add_header Access\-Control\-Allow\-Methods "POST, OPTIONS";\r\n| |\ | | * 不携带always参数：新增的自定义响应头，所有响应码都会带上（2xx、3xx、4xx、5xx都支持）|* add_header Access\-Control\-Allow\-Methods "POST, OPTIONS" always;\r\n| |\ | |* 最多只能配置10个自定义header。 |* add_header Strict\-Transport\-Security "max\-age=63072000; includeSubdomains; preload";\r\n | | |client_header_timeout |* 定义读取客户端请求头的超时时间。|30\-120s |60s |\ | |* 如果客户端在这段时间内没有传输整个报头，则将返回 408错误码给客户端，表示请求超时。 | | | |proxy_read_timeout |* 定义 ALB 从后端服务器读取响应的超时时间。|30\-3600s |60s |\ | |* 此超时时间仅针对两个连续的读操作之间设置，而不是整个响应的传输过程。| | |\ | |* 如果后端服务器在该时间内未传输任何内容，则关闭连接。 | | | |proxy_send_timeout |* 定义 ALB 将请求传输到后端服务器的超时时间。|30\-3600s |60s |\ | |* 此超时时间仅针对两个连续的写操作之间设置，而不是整个请求的传输过程。| | |\ | |* 如果后端服务器在该时间内未收到任何内容，则关闭连接。 | | | |client_body_timeout |* 定义读取客户端请求参数的超时时间。|30\-120s |60s |\ | |* 此超时时间仅针对两个连续读操作之间的时间间隔设置，而不是整个请求的传输过程。| | |\ | |* 如果客户端在这段时间内没有发送任何内容，则将返回 408错误码给客户端，表示请求超时。 | | | |send_timeout |* 定义向客户端发送响应的超时时间。|1\-3600s |60s |\ | |* 此超时时间仅针对两个连续的写入操作之间设置，而不是整个响应的传输过程。| | |\ | |* 如果客户端在此时间内没有收到任何内容，则连接将被关闭。 | | | |ssl_verify_depth |定义客户端证书链的验证深度。 |3～10 |3 | |ssl_session_timeout |* 定义客户端保存 Session Ticket 的时间。|1\-60分 |10分 |\ | |* 过期后客户端将删除该 Ticket。 | | | |proxy_buffer_size |设置接收后端响应的缓存区大小。 |4\-32k |4k | |large_client_header_buffers |* 设置用于读取大型客户端请求标头的缓存区的最大数量和大小。|最大数量输入范围：4\-8。|最大数量输入范围默认取值：4。|\ | |* 请求行不能超过一个缓存区的大小，否则会向客户端返回 414 错误。请求头字段不能超过一个缓存区的大小，否则会向客户端返回 400 错误。 |大小输入范围：8\-32k。 |大小输入范围默认取值：8k。 | |more_set_input_headers |将指定的字段添加到请求报头中。具体规则如下：|* 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 | |\ | |* header key| | |\ | | * 由（_）、（\-）、字母、数字组成的字符串。| | |\ | | * 长度不超过128字符。| | |\ | | * 不支持以（\-）开头。| | |\ | | * 不允许重复。| | |\ | |* value| | |\ | | * 只能是变量或者其他字符串。| | |\ | | * 由字母、数字、（_）、（\-）、（\*）、（,）（/）、（@）、（=）、（.）、英文括号、空格、单引号组成的字符串。不能有（;）。| | |\ | | * 引号只能出现在开始字符和末尾字符。| | |\ | | * 首尾不能出现空格。| | |\ | | * 长度不超过128字符。| | |\ | |* 最多只能配置10个自定义header。 | | | |proxy_pass_header |指定强制透传的后端响应头。该响应头会被强制透传到客户端。即使 ALB 有相同名称的响应头，也不会覆盖从后端服务器传来的指定响应头。 |Server |Server | ## 返回参数 |**参数** |**类型** |**参数说明** |**示例值** | |---|---|---|---| | | | |20210811152539010225146063030\*\*\*\* |\ |RequestId |String |请求ID。 | | |CustomizedCfgId |String |个性化配置 ID 。 |ccfg\-3cj44nv0jhhxc6c6rrtet\*\*\*\* | ## 示例 ### 请求示例 ```http 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: alb.cn-beijing.volcengineapi.com Region: cn-beijing ServiceName: alb ``` ### 返回示例 ```json { "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 的错误码，更多错误码请参见[公共错误码](../6406/113579)。 |**HTTP Code** |**错误码** |**错误信息** |**错误描述** | |---|---|---|---| |400 |InvalidCustomizedCfgName.Malformed |The specified CustomizedCfgName is malformed. |指定的 CustomizedCfgName 参数格式不合法。 | |400 |InvalidDescription.Malformed |The 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 配置不合法。 | |400 |InvalidCustomizedCfgContent.Malformed |The specified CustomizedCfgContent is malformed. keepalive_timeout config in CustomizedCfgContent is invalid. |指定的 CustomizedCfgContent 参数格式不合法。其中的 keepalive_timeout 配置不合法。 | |400 |InvalidCustomizedCfgContent.Malformed |The 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 配置不合法。 | |400 |InvalidCustomizedCfgContent.Malformed |The specified CustomizedCfgContent is malformed. ssl_verify_depth config in CustomizedCfgContent is invalid. |指定的 CustomizedCfgContent 参数格式不合法。其中的 ssl_verify_depth 配置不合法。 | |400 |InvalidCustomizedCfgContent.Malformed |The 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 配置不合法。 | |400 |InvalidCustomizedCfgContent.Malformed |The specified CustomizedCfgContent is malformed. proxy_send_timeout config in CustomizedCfgContent is invalid. |指定的 CustomizedCfgContent 参数格式不合法。其中的 proxy_send_timeout 配置不合法。 | |400 |InvalidCustomizedCfgContent.Malformed |The specified CustomizedCfgContent is malformed. proxy_read_timeout config in CustomizedCfgContent is invalid. |指定的 CustomizedCfgContent 参数格式不合法。其中的 proxy_read_timeout 配置不合法。 | |400 |InvalidCustomizedCfgContent.Malformed |The 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 配置不合法。 | |400 |InvalidCustomizedCfgContent.Malformed |The 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 配置不合法。 | |400 |OperationFailed.QueryProject |The 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 配置项重复。 | |400 |InvalidCustomizedCfgContent.Duplicated |The 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 配置项重复。 | |404 |InvalidProject.NotFound |The specified Project does not exist. |指定的项目不存在。 | |400 |InvalidTags.Key.Malformed |The specified Tags.Key is malformed. |指定的 Tags.Key 参数格式不合法。 | |400 |InvalidTags.Value.Malformed |The specified Tags.Value is malformed. |指定的 Tags.Value 参数格式不合法。 | |400 |InvalidTags.Key.Duplicated |The specified Tags.Key is duplicated. |指定的 Tags.Key 重复。 |

负载均衡