详情页标题前

阿里云负载均衡GetListenerAttribute – 查询监听的属性-云淘科技

• 阿里云负载均衡
详情页1

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

调试

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

调试阿里云负载均衡GetListenerAttribute - 查询监听的属性-云淘科技调试

授权信息

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

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

请求参数

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

监听ID。

 lsn-bp1bpn0kn908w4nbw****
DryRun boolean 否

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

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

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

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

说明
若您未指定，则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId不一样。

123e4567-e89b-12d3-a456-426655440000
RegionIdstring否

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

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

 cn-hangzhou

返回参数

名称 类型 描述 示例值
object

查询监听属性。
RequestId string

请求ID。

 CEF72CEB-54B6-4AE8-B225-F876FF7BA984
RegionId string

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

 cn-hangzhou
LoadBalancerId string

网络型负载均衡实例ID。

 nlb-83ckzc8d4xlp8o****
ListenerId string

监听ID。

 lsn-ga6sjjcll6ou34l1et****
ListenerProtocol string

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

 TCPSSL
ListenerPort integer

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

 233
StartPort string

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

 233
EndPort string

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

 455
ListenerDescription string

自定义监听名称。

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

 tcpssl_443
ServerGroupId string

服务器组ID。

 sgp-ppdpc14gdm3x4o****
IdleTimeout integer

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

 900
SecurityPolicyId string

安全策略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。
    • 创建自定义策略，请参见CreateSecurityPolicy。
    • 查询安全策略，请参见ListSecurityPolicy。

说明
仅对TCPSSL监听生效。

tls_cipher_policy_1_0
CertificateIdsarray

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

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

string

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

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

12315790212_166f8204689_1714763408_70998****
CaCertificateIdsarray

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

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

string

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

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

139a00604ad-cn-east-hangzh****
CaEnabledboolean

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

  • true：启动。

  • false：关闭。

 false
AlpnEnabled boolean

是否开启ALPN。取值：

  • true：开启。

  • false：关闭。

 false
AlpnPolicy string

ALPN策略。取值：

  • HTTP1Only
  • HTTP2Only
  • HTTP2Preferred
  • HTTP2Optional
 HTTP1Only
ProxyProtocolEnabled boolean

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

  • true：开启。

  • false：关闭。

 false
ProxyProtocolV2Config object

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

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

  • true：开启。

  • false：关闭。

 false
Ppv2PrivateLinkEpIdEnabled string

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

  • true：开启。

  • false：关闭。

 false
Ppv2PrivateLinkEpsIdEnabled string

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

  • true：开启。

  • false：关闭。

 false
SecSensorEnabled boolean

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

  • true：开启。

  • false：关闭。

 false
ListenerStatus string

当前监听的状态，取值：

  • Provisioning：创建中。

  • Running：运行中。

  • Configuring：配置中。

  • Stopping：停止中。

  • Stopped：已停止。

  • Starting：启动中。

  • Deleting：删除中。

  • Deleted：已删除。

 Running
Cps integer

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

 1000
Mss integer

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

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

166
Tagsobject []

标签列表。
TagKey string

标签键。

 ac-cus-tag-4
TagValue string

标签值。

 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": [
    "12315790212_166f8204689_1714763408_70998****"
  ],
  "CaCertificateIds": [
    "139a00604ad-cn-east-hangzh****"
  ],
  "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 错误码 错误信息 描述
404 ResourceNotFound.loadBalancer The specified resource of loadbalancer is not found. 找不到指定的负载均衡器资源，请检查输入参数。
404 ResourceNotFound.listener The specified resource %s is not found. 资源%s不存在。

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

变更历史

变更时间 变更内容概要 操作
2023-11-27 OpenAPI 错误码发生变更，OpenAPI 返回结构发生变更 看变更集
变更项 变更内容
错误码 OpenAPI 错误码发生变更
    删除错误码：403
    删除错误码：404
出参 OpenAPI 返回结构发生变更
2023-10-10 OpenAPI 错误码发生变更 看变更集
变更项 变更内容
错误码 OpenAPI 错误码发生变更
    删除错误码：404
    新增错误码：403
2023-09-26 OpenAPI 错误码发生变更 看变更集
变更项 变更内容
错误码 OpenAPI 错误码发生变更
    错误码 404 变更
2023-09-12 OpenAPI 错误码发生变更 看变更集
变更项 变更内容
错误码 OpenAPI 错误码发生变更
    新增错误码：404
2023-06-29 OpenAPI 返回结构发生变更 看变更集
变更项 变更内容
出参 OpenAPI 返回结构发生变更

内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家

阿里云企业补贴进行中： 马上申请

腾讯云限时活动1折起，即将结束： 马上收藏

同尘科技为腾讯云授权服务中心。

购买腾讯云产品享受折上折，更有现金返利:同意关联，立享优惠

转转请注明出处：https://www.yunxiaoer.com/168066.html

赞 (0)
0
上一篇 2023年12月10日
下一篇 2023年12月10日
详情页2

相关推荐

  • 阿里云日志服务SLS语法简介-云淘科技

    SLS DSL基于Python语言开发，提供两百多个内置函数来简化数据加工任务。本文介绍DSL的语言模式、分类和运行原理等。 语言模式 SLS DSL兼容Python，标准模式下，SLS DSL可视为Python的子集。除基本的数据结构与表达方式外，语法规则是以函数方式进行编排。如果您有特定UDF的需求，请提交工单。 类别 Python语法 标准模式 数据结…

    阿里云日志服务SLS 2023年12月10日

  • 阿里云日志服务SLSListConsumerGroup-云淘科技

    调用ListConsumerGroup接口查询指定Logstore的所有消费组。 接口说明 Host由Project名称和日志服务Endpoint构成，您需要在Host中指定Project。 已创建并获取AccessKey。更多信息，请参见访问密钥。 阿里云账号AccessKey拥有所有API的访问权限，风险很高。强烈建议您创建并使用RAM用户进行API访问…

    阿里云日志服务SLS 2023年12月10日
  • 信息流广告，信息流部分建议宽度830px，只针对默认列表样式，顺序随机

  • 阿里云负载均衡CreateListener – 创建监听-云淘科技

    在网络型负载均衡实例中创建TCP、UDP或TCPSSL监听。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。 调试调试授权信息下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API…

    阿里云负载均衡 2023年12月10日

  • 阿里云负载均衡DeleteRules – 批量删除转发规则-云淘科技

    批量删除同一监听下的转发规则。 接口说明 DeleteRules接口属于异步接口，即系统返回一个请求ID，但该多条转发规则尚未删除成功，系统后台的删除任务仍在进行。您可以调用ListRules查询多条转发规则的删除状态： 当多条转发规则处于Deleting状态时，表示多条转发规则正在删除中。 当查询不到多条转发规则的状态时，表示多条转发规则删除成功。 调试 …

    阿里云负载均衡 2023年12月10日

  • 阿里云大数据开发治理平台 DataWorksGetMetaTableLineage-云淘科技

    调用GetMetaTableLineage获取表的血缘关系。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。 请求参数 名称 类型 是否必选 示例值 描述 Action String 是 GetMetaTableLineage 系统规定参数。取值：…

    阿里云大数据开发治理平台 DataWorks 2023年12月10日

联系我们

400-800-8888

在线咨询： QQ交谈

邮件：admin@example.com

工作时间：周一至周五，9:30-18:30，节假日休息

关注微信
本站为广大会员提供阿里云、腾讯云、华为云、百度云等一线大厂的购买，续费优惠，保证底价，买贵退差。