You need to enable JavaScript to run this app.
导航
DescribeCustomizedCfgs
最近更新时间:2024.06.28 16:26:04首次发布时间:2022.07.07 14:48:17

请求说明

API 名称:DescribeCustomizedCfgs。
API 域名:open.volcengineapi.com。
API 描述:查询个性化配置列表。

使用限制

节流限制:每秒最多提交 40 个 API 请求。

调试

URI 参数

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

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

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

请求参数

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

参数类型是否必选参数说明示例值
PageNumber
Integer
列表的页码,默认值为1。
1
PageSizeInteger分页查询时每页的行数,取值:1 ~ 100,默认为10。10
CustomizedCfgNameString要查询的个性化配置名称。myCustomizedCfgName
CustomizedCfgIds.NList of String要查询的个性化配置Id列表,最多20个。Ids.1=ccfg-xxxxx& Ids.2=ccfg-yyyyy
ListenerIdString查询指定监听器关联的个性化配置。listenerId=lsn-3tihaugk2y3vj0wt****
ProjectNameString个性化配置所属项目名称。default

返回参数

参数类型参数说明示例值
RequestId
String
请求 ID 。
20210811152539010225146063030****
PageSizeInteger当前分页的行数。20
PageNumberInteger当前页码。1
TotalCountInteger符合条件的个性化配置总数。50
CustomizedCfgsArray符合条件的个性化配置信息,具体参见下表 CustomizedCfgs-

CustomizedCfgs

参数类型参数说明示例值
CustomizedCfgIdString个性化配置的 ID 。ccfg-3cj44nv0jhhxc6c6rrtet****
CustomizedCfgNameString个性化配置的名称。myCustomizedCfg
CreateTimeString个性化配置的创建时间。2021-08-11T16:37:37Z
UpdateTimeString个性化配置的最近操作时间。2021-08-11T16:37:37Z
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;

StatusString个性化配置状态。包括Active、Configuring、Creating或者DeletingActive
ListenersList个性化配置关联的监听器 ID。[ lsn-3tihaugk2y3vj0wt**** , lsn-2fe6fszjgeznk5oxruv0u**** ]
DescriptionString个性化配置的描述。测试
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

-

示例

请求示例

GET /?Action=DescribeCustomizedCfgs&ProjectName=default&Version=2020-04-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: alb

返回示例

{
    "ResponseMetadata":{
        "RequestId": "3d3c995b-bbcd-49e0-9fcd-ded44032****",
        "Action": "DescribeCustomizedCfgs",
        "Version": "2020-04-01",
        "Service": "alb",
        "Region": "cn-beijing"
    },
    "Result":{
        "RequestId": "3d3c995b-bbcd-49e0-9fcd-ded44032****"
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 2,
        "CustomizedCfgs": [{
            "CreateTime": "2022-06-10T09:19:16Z",
            "UpdateTime": "2022-06-10T09:19:16Z",
            "CustomizedCfgId": "ccfg-3lk5o0tulupdswet340b****",
            "CustomizedCfgContent": "client_max_body_size 60M;keepalive_timeout 75s;",
            "CustomizedCfgName": "test-1",
            "Description": "test-1",
            "Status": "Active",
            "Listeners": []
        }, {
            "CreateTime": "2022-06-10T09:15:39Z",
            "UpdateTime": "2022-06-10T09:15:39Z",
            "CustomizedCfgId": "ccfg-3lk5o0rvkqneowet342m****",
            "CustomizedCfgContent": "client_max_body_size 60M;",
            "CustomizedCfgName": "test-2",
            "Description": "test-2",
            "Status": "Active",
            "Listeners": []
        }]
    }
}

错误码

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

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

400

InvalidPaging.Malformed

The specified PageNumber or PageSize is malformed.

指定的分页参数格式不合法。

400

LimitExceed.CustomizedCfg

You've reached the limit on the number of CustomizedCfgs that you can operate at a time.

已达到单次可操作的个性化配置的数量上限。

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