You need to enable JavaScript to run this app.
文档中心
负载均衡

负载均衡

复制全文
下载 pdf
个性化配置
DescribeCustomizedCfgs - 查询个性化配置列表
复制全文
下载 pdf
DescribeCustomizedCfgs - 查询个性化配置列表
调用 DescribeCustomizedCfgs 接口,查询个性化配置列表。​
使用说明​
每秒最多提交 40 个 API 请求。​
请求说明​
  • 请求方式:GET​
  • 请求地址:/?Action=DescribeCustomizedCfgs&Version=2020-04-01​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:DescribeCustomizedCfgs​
要执行的操作,取值:DescribeCustomizedCfgs。​
​
Version string 必选 示例值:2020-04-01​
API的版本,取值:2020-04-01。​
​
CustomizedCfgName string 可选 示例值:myCustomizedCfgName​
要查询的个性化配置名称。​
​
CustomizedCfgIds.N string[] 可选 示例值:CustomizedCfgIds.1=ccfg-xxxxx&CustomizedCfgIds.2=ccfg-yyyyy​
要查询的个性化配置Id列表,最多20个。​
​
ListenerId string 可选 示例值:listenerId=lsn-3tihaugk2y3vj0wt****​
查询指定监听器关联的个性化配置。​
​
PageNumber integer 可选 示例值:1​
列表的页码,默认值为1。​
​
PageSize integer 可选 示例值:10​
分页查询时每页的行数,取值:1 ~ 100,默认为10。​
​
TagFilters.N.Key string[] 可选 示例值:TagFilters.1.Key=k1&TagFilters.2.Key=k2​
标签的标签键。​
  • 参数 - N:表示标签键的序号,取值范围:1~10。​
  • 多个标签键之间用&分隔。多个标签键之间的关系为逻辑“与(AND)”,即查询同时添加多个标签键的个性化配置。​
  • 不允许重复。​
​
TagFilters.N.Values.N string[] 可选 示例值:TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.2.Values.1=v3​
标签的标签值。​
  • 第一个N:表示标签键的序号,取值范围:1~10。​
  • 第二个N:表示标签值的序号,取值范围:1~3。同一标签键多个标签值之间的关系为逻辑“或(OR)”,即查询同一标签键下添加其中一个标签值的个性化配置。​
  • 多个标签值之间用&分隔。​
说明​
  • 若传入该参数,则必须先传入TagFilters.N.Key。​
  • 传入空字符串时,表示查询标签值为空的个性化配置。​
​
ProjectName string 可选 示例值:default​
个性化配置所属项目名称。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
RequestId string 示例值:20210811152539010225146063030****​
请求 ID 。​
​
PageSize integer 示例值:20​
当前分页的行数。​
​
PageNumber integer 示例值:1​
当前页码。​
​
TotalCount integer 示例值:50​
符合条件的个性化配置总数。​
​
CustomizedCfgs object[] 示例值:--​
符合条件的个性化配置信息 。​
CustomizedCfgId string 示例值:ccfg-3cj44nv0jhhxc6c6rrtet****​
个性化配置的 ID。​
​
CustomizedCfgName string 示例值:myCustomizedCfg​
个性化配置的名称。​
​
CreateTime string 示例值:2021-08-11T16:37:37Z​
个性化配置的创建时间。​
​
UpdateTime string 示例值:2021-08-11T16:37:37Z​
个性化配置的最近操作时间。​
​
CustomizedCfgContent string 示例值:client_max_body_size 60M; keepalive_timeout 75s;​
要修改的个性化配置项内容。具体规则如下:​
  • 长度不超过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。详细信息参见文末个性化配置项内容。​
​
Status string 示例值:Active​
个性化配置状态。​
  • Active​
  • Configuring​
  • Creating​
  • Deleting​
​
Listeners string[] 示例值:[ lsn-3tihaugk2y3vj0wt**** , lsn-2fe6fszjgeznk5oxruv0u**** ]​
个性化配置关联的监听器 ID。​
​
Description string 示例值:test​
个性化配置的描述。​
​
ProjectName string 示例值:default​
个性化配置所属项目名称。​
​
Tags object[] 示例值:--​
个性化配置所属标签。​
Key string 示例值:key​
用户标签的标签键。​
​
Value string 示例值:value​
用户标签的标签值。​
​
​
​
​
​
请求示例​
​
GET /?Action=DescribeCustomizedCfgs&ProjectName=default&Version=2020-04-01 HTTP/1.1​
Host: alb.cn-beijing.volcengineapi.com​
X-Date: 20251121T094038Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-beijing/alb/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"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": []​
}]​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
400​
Invalid%s.Malformed​
MismatchThe specified %s is malformed.​
指定的 %s 参数格式不合法。​
400​
InvalidCustomizedCfgName.Malformed​
The specified CustomizedCfgName is malformed.​
指定的 CustomizedCfgName 参数格式不合法。​
400​
InvalidPaging.Malformed​
The specified PageNumber or PageSize is malformed.​
指定的分页参数格式不合法。​
400​
InvalidParameter​
Data unmarshal failed.​
请求解析失败。​
400​
InvalidTagFilters.Key.Duplicated​
The specified TagFilters.Key is duplicated.​
指定的 TagFilters.Key 重复。​
400​
InvalidTagFilters.Key.Malformed​
The specified TagFilters.Key is malformed.​
指定的 TagFilters.Key 参数格式不合法。​
400​
InvalidTagFilters.Value.Malformed​
The specified TagFilters.Value is malformed.​
指定的 TagFilters.Value 参数格式不合法。​
400​
LimitExceed.CustomizedCfg​
You've reached the limit on the number of CustomizedCfgs that you can operate at a time.​
已达到单次可操作的个性化配置的数量上限。​
400​
LimitExceed.TagFilters.Values​
You've reached the limit on the number of tag filter values that you can operate at a time.​
已达到单次可操作的标签值的数量上限。​
400​
MissingParameter​
The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, '%s'.​
该请求缺少必要参数。请确保发起请求已提供全部必要参数,比如: %s。​
500​
InternalError​
An internal error has occurred.​
发生内部错误。请稍后重试或联系工程师进一步咨询。​
​
​
最近更新时间:2026.10.28 10:15:05
这个页面对您有帮助吗?
有用
有用
无用
无用