API 名称:DescribeCustomizedCfgAttributes。
API 域名:open.volcengineapi.com。
API 描述:查询指定个性化配置详细信息。
节流限制:每秒最多提交 40 个 API 请求。
在使用该部分 API 提交请求时必须包含以下 URI 参数。
除了 URI 参数,该 API 请求还需要包含签名参数。关于更多签名参数的信息,参见公共请求参数 。
名称 | 类型 | 是否必选 | 格式 | 说明 |
---|---|---|---|---|
Action | string | 是 | [a-zA-Z]+ | API 名称,如 DescribeCustomizedCfgAttributes 。 |
Version | string | 是 | YYYY-MM-DD | API 版本信息。该参数的取值是 2020-04-01 。 |
X-Expires | int | 否 | 900 | 表示签名的有效时间,单位是秒,默认值是900。 |
在使用该 API 提交请求时,请求参数中可以包含的参数如下。
参数 | 类型 | 是否必选 | 参数说明 | 示例值 |
---|---|---|---|---|
CustomizedCfgId | String | 是 | 要查询的个性化配置 ID。 | ccfg-3cj44nv0jhhxc6c6rrtet**** |
参数 | 类型 | 参数说明 | 示例值 |
---|---|---|---|
RequestId | String | 请求 ID 。 | 20210811152539010225146063030**** |
CustomizedCfgId | String | 个性化配置的 ID 。 | ccfg-3cj44nv0jhhxc6c6rrtet**** |
CustomizedCfgName | String | 个性化配置的名称。 | myCustomizedCfg |
CreateTime | String | 个性化配置的创建时间。 | 2021-08-11T16:37:37Z |
UpdateTime | String | 个性化配置的最近操作时间。 | 2021-08-11T16:37:37Z |
CustomizedCfgContent | String | 要修改的个性化配置项内容。具体规则如下:
| client_max_body_size 60M; |
Status | String | 个性化配置状态。包括Active、Configuring、Creating或者Deleting | Active |
Listeners | Array | 个性化配置关联的监听器详细信息。具体参见下表 Listeners 。 | - |
Description | String | 个性化配置的描述。 | 测试 |
ProjectName | String | 个性化配置所属项目名称。 | default |
个性化配置项内容
配置项 | 说明 | 取值范围 | 默认值 |
---|---|---|---|
proxy_connect_timeout | upstream 后端连接超时间。 | 4~120s | 4s |
keepalive_timeout | Client-Server 长连接保持时间,设置为0则禁用长连接。 | 0~900s | 75s |
client_max_body_size |
| 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 |
ssl_ciphers | 加密套件。多个加密套件使用":"分隔。 |
| 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 | 将指定的字段添加到响应报头中。具体规则如下:
|
| - |
client_header_timeout |
| 30-120s | 60s |
proxy_read_timeout |
| 30-3600s | 60s |
proxy_send_timeout |
| 30-3600s | 60s |
client_body_timeout |
| 30-120s | 60s |
send_timeout |
| 1-3600s | 60s |
ssl_verify_depth | 定义客户端证书链的验证深度。 | 3~10 | 3 |
ssl_session_timeout |
| 1-60分 | 10分 |
proxy_buffer_size | 设置接收后端响应的缓存区大小。 | 4-32k | 4k |
large_client_header_buffers |
| 最大数量输入范围:4-8。 | 最大数量输入范围默认取值:4。 |
more_set_input_headers | 将指定的字段添加到请求报头中。具体规则如下:
|
| - |
proxy_pass_header | 强制透传的后端响应头。该响应头会被强制透传到客户端。即使 ALB 有相同名称的响应头,也不会覆盖从后端服务器传来的指定响应头。 | Server | Server |
Listeners
参数 | 类型 | 参数说明 | 示例值 |
---|---|---|---|
ListenerId | String | 监听器的 ID。 | lsn-2fek3rgsxhrsw5oxruwec**** |
ListenerName | String | 监听器的名称。 | mylistener |
Protocol | String | 监听器的协议。包括 HTTP 、HTTPS 。 | HTTP |
Port | Integer | 监听器的端口。 | 80 |
GET /?Action=DescribeCustomizedCfgAttributes&CustomizedCfgId=ccfg-3lk5o0tulupdswet340b****&Version=2020-04-01 HTTP/1.1 Host: open.volcengineapi.com Region: cn-beijing ServiceName: alb
{
"ResponseMetadata":{
"RequestId": "37f2bcb3-61f1-408a-98c0-ea4add33****",
"Action": "DescribeCustomizedCfgAttributes",
"Version": "2020-04-01",
"Service": "alb",
"Region": "cn-beijing"
},
"Result":{
"RequestId": "37f2bcb3-61f1-408a-98c0-ea4add33****",
"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": "yxl-test-1",
"Description": "yxl-test",
"Status": "Active",
"Listeners": []
}
}
如果响应正文包含 Error 字段,则表示 API 请求失败。此处仅展示当前 API 的错误码,更多错误码请参见公共错误码。
HTTP Code | 错误码 | 错误信息 | 错误描述 |
---|---|---|---|
404 | InvalidCustomizedCfg.NotFound | The specified CustomizedCfg does not exist. | 指定的个性化配置不存在。 |