备案控制台
文档
产品文档
输入文档关键字查找
首页 负载均衡 网络型负载均衡NLB 开发参考 API参考 API目录 监听 GetListenerAttribute - 查询监听的属性

GetListenerAttribute - 查询监听的属性

更新时间：
一键部署
产品详情
相关技术圈
我的收藏

查询网络型负载均衡实例的监听详情。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
nlb:GetListenerAttributeRead
  • LoadBalancer
    acs:nlb:{#regionId}:{#accountId}:loadbalancer/{#LoadBalancerId}
    无
无

请求参数

名称类型必填描述示例值
ListenerIdstring是

监听 ID。

lsn-bp1bpn0kn908w4nbw****
DryRunboolean否

是否只预检此次请求。取值：

  • true：发送检查请求，不会查询监听详情。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过，则返回对应错误。如果检查通过，则返回错误码DryRunOperation。
  • false（默认值）：发送正常请求，通过检查后返回 HTTP 2xx 状态码并直接进行操作。
false
ClientTokenstring否

客户端 Token，用于保证请求的幂等性。

从您的客户端生成一个参数值，确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明 若您未指定，则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
123e4567-e89b-12d3-a456-426655440000
RegionIdstring否

网络型负载均衡实例所在的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou

返回参数

名称类型描述示例值
object

查询监听属性。

RequestIdstring

请求 ID。

CEF72CEB-54B6-4AE8-B225-F876FF7BA984
RegionIdstring

网络型负载均衡实例所在的地域 ID。

cn-hangzhou
LoadBalancerIdstring

网络型负载均衡实例 ID。

nlb-83ckzc8d4xlp8o****
ListenerIdstring

监听 ID。

lsn-ga6sjjcll6ou34l1et****
ListenerProtocolstring

监听协议。取值：TCP、UDP 或 TCPSSL。

TCPSSL
ListenerPortinteger

监听端口。取值范围：0~65535。0：表示使用全端口监听。当设置为 0 时，您需要配置 StartPort 和 EndPort。

233
StartPortstring

全端口监听起始端口。取值范围：0 ~ 65535。

233
EndPortstring

全端口监听结束端口。取值范围：0~ 65535。结束端口的取值小于起始端口。

455
ListenerDescriptionstring

自定义监听名称。

长度限制为 2~256 个字符，支持中文和英文字母，可包含数字、半角逗号（,）、半角句号（.）、半角分号（;）、正斜线（/）、at（@）、下划线（_）和短划线（-）。

tcpssl_443
ServerGroupIdstring

服务器组 ID。

sgp-ppdpc14gdm3x4o****
IdleTimeoutinteger

连接空闲超时时间。单位：秒。取值范围：1~900。

900
SecurityPolicyIdstring

安全策略 ID。支持系统安全策略和自定义安全策略。

  • 系统策略取值：tls_cipher_policy_1_0（默认值）、tls_cipher_policy_1_1、tls_cipher_policy_1_2、tls_cipher_policy_1_2_strict或tls_cipher_policy_1_2_strict_with_1_3。
  • 自定义安全策略：输入自定义安全策略 ID。
说明 仅对 TCPSSL 监听生效。
tls_cipher_policy_1_0
CertificateIdsarray

服务器证书列表信息。目前仅支持添加 1 个服务器证书。

说明 该参数仅对 TCPSSL 监听生效。
string

服务器证书列表信息。目前仅支持添加 1 个服务器证书。

说明 该参数仅对 TCPSSL 监听生效。
123157******
CaCertificateIdsarray

CA 证书列表信息。目前仅支持添加 1 个 CA 证书。

说明 该参数仅对 TCPSSL 监听生效。
string

CA 证书列表信息。目前仅支持添加 1 个 CA 证书。

说明 该参数仅对 TCPSSL 监听生效。
139a00******
CaEnabledboolean

是否启动双向认证。取值：

  • true：启动。

  • false：关闭。

false
AlpnEnabledboolean

是否开启 ALPN。取值：

  • true：开启。

  • false：关闭。

false
AlpnPolicystring

ALPN 策略。取值：

  • HTTP1Only
  • HTTP2Only
  • HTTP2Preferred
  • HTTP2Optional
HTTP1Only
ProxyProtocolEnabledboolean

是否开启通过 Proxy Protocol 协议携带客户端源地址到后端服务器。取值：

  • true：开启。

  • false：关闭。

false
ProxyProtocolV2Configobject

通过 Proxy Protocol 协议携带 VpcId、PrivateLinkEpId、PrivateLinkEpsId 信息到后端服务器配置。

Ppv2VpcIdEnabledboolean

是否开启通过 Proxy Protocol 协议携带 VpcId 到后端服务器。取值：

  • true：开启。

  • false：关闭。

false
Ppv2PrivateLinkEpIdEnabledboolean

是否开启通过 Proxy Protocol 协议携带 PrivateLinkEpId 到后端服务器。取值：

  • true：开启。

  • false：关闭。

false
Ppv2PrivateLinkEpsIdEnabledboolean

是否开启通过 Proxy Protocol 协议携带 PrivateLinkEpsId 到后端服务器。取值：

  • true：开启。

  • false：关闭。

false
SecSensorEnabledboolean

是否开启秒级监控功能。取值：

  • true：开启。

  • false：关闭。

false
ListenerStatusstring

当前监听的状态，取值：

  • Provisioning：创建中。

  • Running：运行中。

  • Configuring：配置中。

  • Stopping：停止中。

  • Stopped：已停止。

  • Starting：启动中。

  • Deleting：删除中。

  • Deleted：已删除。

Running
Cpsinteger

网络型负载均衡实例每秒新建连接限速值。取值范围：0~1000000。0 表示不限速。

1000
Mssinteger

TCP 报文的最大段大小。单位：字节，取值范围：0~1500。0 表示不修改用户 TCP 报文的 MSS 值。

说明 仅 TCP、TCPSSL 类型的监听支持该字段值。
166
Tagsobject []

标签列表。

TagKeystring

标签键。

ac-cus-tag-4
TagValuestring

标签值。

ON

示例

正常返回示例

JSON格式

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "RegionId": "cn-hangzhou",
  "LoadBalancerId": "nlb-83ckzc8d4xlp8o****",
  "ListenerId": "lsn-ga6sjjcll6ou34l1et****",
  "ListenerProtocol": "TCPSSL",
  "ListenerPort": 233,
  "StartPort": "233",
  "EndPort": "455",
  "ListenerDescription": "tcpssl_443",
  "ServerGroupId": "sgp-ppdpc14gdm3x4o****",
  "IdleTimeout": 900,
  "SecurityPolicyId": "tls_cipher_policy_1_0",
  "CertificateIds": [
    "123157******"
  ],
  "CaCertificateIds": [
    "139a00******"
  ],
  "CaEnabled": false,
  "AlpnEnabled": false,
  "AlpnPolicy": "HTTP1Only",
  "ProxyProtocolEnabled": false,
  "ProxyProtocolV2Config": {
    "Ppv2VpcIdEnabled": false,
    "Ppv2PrivateLinkEpIdEnabled": false,
    "Ppv2PrivateLinkEpsIdEnabled": false
  },
  "SecSensorEnabled": false,
  "ListenerStatus": "Running",
  "Cps": 1000,
  "Mss": 166,
  "Tags": [
    {
      "TagKey": "ac-cus-tag-4",
      "TagValue": "ON"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400SystemBusySystem is busy, please try again later.系统繁忙，请稍后重试
404ResourceNotFound.loadBalancerThe specified resource of loadbalancer is not found.找不到指定的负载均衡器资源，请检查输入参数。
404ResourceNotFound.listenerThe specified resource %s is not found.资源%s不存在。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-02-04OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    删除错误码：404
    新增错误码：400
2023-12-12OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    删除错误码：404
出参OpenAPI 返回结构发生变更。
2023-11-27OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    删除错误码：403
    删除错误码：404
出参OpenAPI 返回结构发生变更。
2023-10-10OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    删除错误码：404
    新增错误码：403
2023-09-26OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    错误码 404 变更
2023-09-12OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更。
    新增错误码：404
2023-06-29OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更。
文档推荐
  • 本页导读 （1）
文档反馈