详情页标题前

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

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

在网络型负载均衡实例中创建TCP、UDP或TCPSSL监听。

调试

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

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

授权信息

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

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

请求参数

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

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

 TCP
ListenerPort integer 是

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

0：表示使用全端口功能。当设置为0时，您需要配置StartPort和EndPort。

 80
ListenerDescription string 否

自定义监听名称。

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

 tcp_80
LoadBalancerId string 是

网络型负载均衡实例ID。

 nlb-83ckzc8d4xlp8o****
ServerGroupId string 是

服务器组ID。

 sgp-ppdpc14gdm3x4o****
IdleTimeout integer 否

连接空闲超时时间。单位：秒。
取值范围：1~900。默认值：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否

服务器证书列表信息。仅对TCPSSL监听生效。

说明
目前仅支持添加1个服务器证书。

string否

服务器证书列表信息。仅对TCPSSL监听生效。

说明
目前仅支持添加1个服务器证书。

12315790212_166f8204689_1714763408_70998****
CaCertificateIdsarray否

CA证书列表。仅对TCPSSL监听生效。

说明
目前仅支持添加1个CA证书。

string否

CA证书列表。仅对TCPSSL监听生效。

说明
目前仅支持添加1个CA证书。

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

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

  • true：启动。

  • false（默认值）：关闭。

 false
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
ProxyProtocolEnabled boolean 否

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

  • true：开启。

  • false（默认值）：关闭。

 false
ProxyProtocolV2Config object 否

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

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

  • true：开启。

  • false（默认值）：关闭。

 false
Ppv2PrivateLinkEpIdEnabled boolean 否

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

  • true：开启。

  • false（默认值）：关闭。

 false
Ppv2PrivateLinkEpsIdEnabled boolean 否

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

  • true：开启。

  • false（默认值）：关闭。

 false
SecSensorEnabled boolean 否

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

  • true：开启。

  • false（默认值）：关闭。

 false
AlpnEnabled boolean 否

是否开启ALPN。取值：

  • true：开启。

  • false（默认值）：关闭。

 false
AlpnPolicy string 否

ALPN策略。取值：

  • HTTP1Only：只协商使用HTTP1.x协议，优先级为HTTP1.1>HTTP1.0。
  • HTTP2Only：只协商使用HTTP2.0协议。
  • HTTP2Optional：优先使用HTTP1.x协议，但也接受HTTP2.0协议，优先级为HTTP1.1>HTTP1.0>HTTP2.0。
  • HTTP2Preferred：优先使用HTTP2.0协议，但也接受HTTP1.x协议，优先级为HTTP2.0>HTTP1.1>HTTP1.0。

说明
AlpnEnabled开启后需配置该参数。

HTTP1Only
StartPortinteger否

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

说明
当ListenerPort为0时，需要配置该参数。

244
EndPortinteger否

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

说明
当ListenerPort为0时，需要配置该参数。

566
Cpsinteger否

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

 100
Mss integer 否

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

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

43
Tagobject []否

标签列表。
Key string 否

标签键。最多支持128个字符，不能以aliyun或acs:开头，不能包含http://或https://。

一次调用最多支持添加20个标签。

 KeyTest
Value string 否

标签值。最多支持128个字符，不能以aliyun或acs:开头，不能包含http://或https://。

一次调用最多支持添加20个标签。

 Test

返回参数

名称 类型 描述 示例值
object

RpcResponse
RequestId string

请求ID。

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

监听ID。

 lsn-bp1bpn0kn908w4nbw****
JobId string

异步任务ID。

 72dcd26b-f12d-4c27-b3af-18f6aed5****

示例

正常返回示例

JSON格式

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "ListenerId": "lsn-bp1bpn0kn908w4nbw****",
  "JobId": "72dcd26b-f12d-4c27-b3af-18f6aed5****"
}

错误码

HTTP status code 错误码 错误信息 描述
400 Conflict.Port The Port [%s] is conflict. 指定的资源当前存在锁冲突。
400 IllegalParam.MssConflictWithUdpAndGeneve The param of MssConflictWithUdpAndGeneve is illegal. Mss值不为null时，listenerProtocol不可以是udp或者GENEVE。
400 QuotaExceeded.%s The quota of %s is exceeded, usage %s/%s. %s的配额超过限制，已使用%s/%s
400 SystemBusy System is busy, please try again later. 系统繁忙，请稍后重试
400 Mismatch.VpcId The VpcId is mismatched for %s and %s. 资源%s和资源%s的VpcId不匹配。请检查两种资源是否在同一个VPC下。
400 ResourceNotEnough.%s The specified resource of %s is not enough. 所需要的资源%s不足了
400 Conflict.Lock The Lock [%s] is conflict. 指定的资源当前存在锁冲突。
400 IllegalParam.AnyPortListenerConflictWithNonAnyPortServerGroup The param of AnyPortListenerConflictWithNonAnyPortServerGroup is illegal. servergroup的全端口转发开关，必须匹配与监听的anyport开关匹配，请检查参数。
400 IllegalParam.PreserveClientIpSwitch The param of PreserveClientIpSwitch is illegal. 参数PreserveClientIpSwitch非法。请检查参数PreserveClientIpSwitch的输入值。
400 IncorrectStatus.loadbalancer The status of loadbalancer [%s] is incorrect. 负载均衡的状态无法进行当前操作，请检查负载均衡当前是否处于其他操作下。
400 ResourceNotFound.Certificate The specified resource %s is not found. 资源%s不存在。
400 IllegalParam.ServerGroupId The param of ServerGroupId is illegal. 参数ServerGroupId非法，请检查输入参数。
400 IllegalParam.NonAnyPortListenerConflictWithAnyPortServerGroup The param of NonAnyPortListenerConflictWithAnyPortServerGroup is illegal. 监听端口配置与全端口转发开关冲突。
400 MissingParam.Certificate The param of certificate is missing. 参数Certificate缺失。
403 Forbidden.%s Authentication is failed for %s. 当前资源或者操作%s鉴权失败
403 Forbidden.NoPermission Authentication is failed for NoPermission. 因为账号没有权限，所以鉴权失败。
404 ResourceNotFound.VSwitch The specified resource of vSwitch is not found. 找不到指定的虚拟交换机资源，请检查输入参数。
404 ResourceNotFound.loadBalancer The specified resource of loadbalancer is not found. 找不到指定的负载均衡器资源，请检查输入参数。

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

变更历史

变更时间 变更内容概要 操作
2023-11-27 OpenAPI 错误码发生变更，OpenAPI 入参发生变更 看变更集
变更项 变更内容
错误码 OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码：403
    删除错误码：404
入参 OpenAPI 入参发生变更
    新增入参：ProxyProtocolV2Config
2023-10-10 OpenAPI 错误码发生变更 看变更集
变更项 变更内容
错误码 OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码：403
    删除错误码：404
2023-10-09 OpenAPI 错误码发生变更 看变更集
变更项 变更内容
错误码 OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码：403
    删除错误码：404
2023-09-26 OpenAPI 错误码发生变更 看变更集
变更项 变更内容
错误码 OpenAPI 错误码发生变更
    错误码 400 变更
    错误码 403 变更
    删除错误码：404
2023-09-12 OpenAPI 错误码发生变更 看变更集
变更项 变更内容
错误码 OpenAPI 错误码发生变更
    错误码 404 变更
    删除错误码：400
    删除错误码：403
2023-09-05 OpenAPI 错误码发生变更 看变更集
变更项 变更内容
错误码 OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码：403
    新增错误码：404
2023-08-22 OpenAPI 错误码发生变更 看变更集
变更项 变更内容
错误码 OpenAPI 错误码发生变更
    新增错误码：400
    新增错误码：403
2023-06-30 API 内部配置变更，不影响调用 看变更集
变更项 变更内容
API 内部配置变更，不影响调用
2023-06-29 OpenAPI 入参发生变更 看变更集
变更项 变更内容
入参 OpenAPI 入参发生变更
    新增入参：Tag
2023-03-30 API 内部配置变更，不影响调用 看变更集
变更项 变更内容
API 内部配置变更，不影响调用

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

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

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

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

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

转转请注明出处：http://www.yunxiaoer.com/168060.html

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

相关推荐

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

    调用CLI命令删除指定Logstore。 请求语法 aliyunlog log delete_logstore –project_name= –logstore_name= [–access-id=] [–access-key=] [–sts-token=] [–region-endpoint=] [–client-name=] [–jmes…

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

  • 阿里云RDS数据库SwitchDBInstanceNetType – 切换经典网络内外网地址-云淘科技

    该接口用于切换经典网络实例的内外网地址。 接口说明 适用引擎 RDS MySQL RDS SQL Server 前提条件 实例只有内网地址和外网地址其中一个。 实例状态为运行中。 24小时内切换次数低于20次。 实例的网络类型为经典网络。 注意事项 切换后连接地址会发生变化，需要您修改代码中的连接地址并重启应用。 调试 您可以在OpenAPI Explore…

    阿里云数据库 2023年12月9日

  • 阿里云日志服务SLS创建资源数据-云淘科技

    资源数据主要用于配置特定告警监控规则所关联的外部数据（例如监控目标的黑白名单），您可以创建、修改和删除这些外部数据。本文介绍创建资源数据的操作。 操作步骤 登录日志服务控制台。 进入资源数据管理页面。 在Project列表区域，单击任意一个Project。 在左侧导航栏中，单击告警。 在告警中心页面，选择其它 > 资源数据。 单击创建，配置资源数据的信…

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

  • 阿里云ECS云服务器DescribeAutoProvisioningGroupHistory-云淘科技

    调用DescribeAutoProvisioningGroupHistory查询弹性供应组的调度任务信息。 调试 您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。 请求参数 名称 类型 是否必选 示例值 描述 Action String 是 Describ…

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

  • 阿里云对象存储OSS简单上传-云淘科技

    简单上传指的是使用PutObject接口上传小于5 GB的单个文件（Object），适用于一次HTTP请求交互即可完成上传的场景。 前提条件 已创建云盒Bucket。具体操作，请参见创建云盒Bucket。 注意事项 文件大小限制 简单上传的Object的大小不能超过5 GB。超过5 GB的Object上传请使用分片上传。 Object命名规则 使用UTF-8…

    阿里云对象存储 2023年12月10日

联系我们

400-800-8888

在线咨询： QQ交谈

邮件：admin@example.com

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

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