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

负载均衡

复制全文
下载 pdf
监听器
DescribeNLBListenerAttributes - 查看监听器的详情
复制全文
下载 pdf
DescribeNLBListenerAttributes - 查看监听器的详情
调用 DescribeNLBListenerAttributes 接口,查看指定监听器的详细信息。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
Action String 必选 示例值:DescribeNLBListenerAttributes​
要执行的操作,取值为 DescribeNLBListenerAttributes。​
​
Version String 必选 示例值:2020-04-01​
API版本信息,当前版本为 2020-04-01。​
​
ListenerId String 必选 示例值:lsn-2fek3rgsxhrsw5oxruwec****​
监听器的ID。​
您可以调用DescribeNLBListeners接口,获取监听器ID。​
​
​
​
返回参数​
RequestId String 示例值:2024092952539010225146063030****​
请求ID。​
​
LoadBalancerId String 示例值:nlb-bp1o94dp5i6ea****​
监听器所属的NLB实例ID。​
​
ListenerId String 示例值:lsn-2fek3rgsxhrsw5oxruwec****​
监听器的ID。​
​
ListenerName String 示例值:mylistener​
监听器的名称。​
​
Description String 示例值:test​
监听器的描述。​
​
ConnectionTimeout Integer 示例值:90​
监听器的连接超时时间。​
​
Protocol String 示例值:TCP​
监听器的协议。​
  • TCP​
  • UDP​
  • TLS​
TLS协议监听器正在邀测中,如需使用,请联系客户经理。​
​
Port Integer 示例值:80​
监听器接收请求使用的端口。​
0表示启用全端口监听。​
​
StartPort Integer 示例值:80​
全端口监听的起始端口。​
仅参数Port为0时,返回该参数。​
​
EndPort Integer 示例值:100​
全端口监听的结束端口。​
仅参数Port为0时,返回该参数。​
​
ServerGroupId String 示例值:rsp-bp1o94dp5i6ea****​
监听器关联的服务器组ID。​
​
SecurityPolicyType String 示例值:tls_cipher_policy_1_0​
TLS 安全策略类型。​
  • custom:自定义策略。​
  • system:系统策略。​
​
SecurityPolicyId String 示例值:tls_cipher_policy_1_0​
TLS 安全策略ID。​
​
CertificateSource String 示例值:SSL​
服务器证书来源。​
  • SSL:证书中心-SSL 证书。​
  • PCALeaf:证书中心-私有CA 的私有证书。​
​
CertificateId String 示例值:cert-3tjuxoukkq3vj0ww****​
默认服务器证书,来源为火山引擎证书中心 SSL 证书。​
​
PCACertificateId String 示例值:pca_leaf_3tjuxo0ww****​
默认服务器证书,来源为火山引擎证书中心私有CA 的私有证书。​
​
CAEnabled Boolean 示例值:true​
是否开启双向认证。​
  • true:是。​
  • false:否。​
​
CACertificateSource String 示例值:PCARoot​
CA证书来源。​
  • PCARoot:私有CA的私有根CA证书。​
  • PCASub:私有CA的私有子CA证书。​
​
CACertificateId String 示例值:pca_root_olkf4tgux9fj0lp***​
CA 证书ID。​
​
Status String 示例值:Active​
监听器的状态。​
  • Creating:创建中。​
  • Active:运行中。​
  • Deleting: 删除中。​
  • Disabled: 已停用。​
​
Enabled Boolean 示例值:true​
是否启用监听器。​
  • true:开启。​
  • false:关闭。​
​
CreateTime String 示例值:2024-08-11T16:37:37Z​
监听器的创建时间。​
​
UpdateTime String 示例值:2024-08-11T16:37:37Z​
监听器的最近操作时间。​
​
Cps Integer 示例值:100​
新建连接数限速值。​
  • 0 表示不限速。​
  • 新建连接数限速功能正在邀测中,如需试用,请联系客户经理。​
​
MaxConnections Integer 示例值:100​
并发连接数限速值。​
  • 0 表示不限速。​
  • 并发连接数限速功能正在邀测中,如需试用,请联系客户经理。​
​
​
​
请求示例​
​
GET /?Action=DescribeNLBListenerAttributes&Version=2020-04-01&ListenerId=lsn-2fek3rgsxhrsw5oxruwec**** HTTP/1.1​
Host: clb.cn-beijing.volcengineapi.com​
Date: 20260310T094038Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-beijing/clb/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "DescribeNLBListenerAttributes",​
"Version": "2020-04-01",​
"Service": "clb",​
"Region": "cn-beijing"​
},​
"Result": {​
"CACertificateId": "pca_root_olkf4tgux9fj0lp***",​
"CACertificateSource": "PCARoot",​
"CAEnabled": true,​
"CertificateId": "cert-3tjuxoukkq3vj0ww****",​
"CertificateSource": "SSL",​
"ConnectionTimeout": 90,​
"CreateTime": "2024-08-11T16:37:37Z",​
"Description": "test",​
"Enabled": true,​
"EndPort": 100,​
"ListenerId": "lsn-2fek3rgsxhrsw5oxruwec****",​
"ListenerName": "mylistener",​
"LoadBalancerId": "nlb-bp1o94dp5i6ea****",​
"PCACertificateId": "pca_leaf_3tjuxo0ww****",​
"Port": 80,​
"Protocol": "TCP",​
"RequestId": "2024092952539010225146063030****",​
"SecurityPolicyId": "tls_cipher_policy_1_0",​
"SecurityPolicyType": "tls_cipher_policy_1_0",​
"ServerGroupId": "rsp-bp1o94dp5i6ea****",​
"StartPort": 80,​
"Status": "Active",​
"UpdateTime": "2024-08-11T16:37:37Z"​
}​
}​
​
错误码​
此处仅展示当前API的错误码,更多错误码请参见公共错误码。​
​
状态码​
错误码​
错误信息​
说明​
400​
DryRunOperation​
Exception raised to indicate a successfully authorized action when the DryRun flag is set to true.​
该请求设置为DryRun操作,操作授权已获得许可,但未被实际执行。​
400​
IdempotentParameterMismatch​
Arguments on this idempotent request are inconsistent with arguments used in previous request(s).​
此幂等请求的参数与前一个请求中使用的参数不一致。​
400​
InvalidClientToken.Malformed​
The specified ClientToken is malformed.​
指定的 ClientToken 参数格式不合法。​
404​
InvalidListener.NotFound​
The specified Listener does not exist.​
指定的监听器不存在。​
409​
InvalidOperation.Conflict​
The specified resource operation conflicts.​
指定的资源操作冲突。​
412​
IdempotentProcessing​
The request uses the same client token as a previous one that is still in process.​
幂等请求处理中。​
​
​
最近更新时间:2026.09.18 11:20:52
这个页面对您有帮助吗?
有用
有用
无用
无用