CreateNLBListener--负载均衡-火山引擎

文档中心

导航

CreateNLBListener

最近更新时间：2024.12.04 17:10:13首次发布时间：2024.12.04 17:10:13

调用 CreateNLBListener 接口，为网络型负载均衡实例添加一个监听器。

请求参数

名称	类型	是否必选	示例值	说明
Action	String	是	CreateNLBListener	要执行的操作，取值为CreateNLBListener。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
LoadBalancerId	String	是	nlb-bp1o94dp5i6ea****	NLB实例的ID。您可以调用DescribeNetworkLoadBalancers接口获取NLB实例ID。
ListenerName	String	否	test	监听器的名称。必须以字母或中文开头，可包含数字、点号（.）、下划线（_）和中划线（-）。长度限制在1～128字符之间。该参数不传入，则默认为“协议-端口”，例如TCP-80。
Protocol	String	是	TCP	监听器的协议。 TCP UDP
Port	Integer	否	80	监听器接收请求使用的端口，取值范围为 0 和 1～65535。 0表示启用全端口监听。
StartPort	Integer	否	1	全端口监听起始端口，取值范围为1 ~ 65535。说明参数`Port`为“0”时，该参数为必填。
EndPort	Integer	否	65535	全端口监听结束端口。取值范围为1 ~ 65535。说明参数`Port`为“0”时，该参数为必填，且取值必须大于`StartPort`。
Enabled	String	否	true	是否启用监听器。取值如下： true（默认值）：开启。 false：关闭。
ConnectionTimeout	Integer	否	800	监听器的连接超时时间。参数`Protocol`为“TCP”时，取值范围为10～900秒，默认为900秒。参数`Protocol`为“UDP”时，取值范围为10～120秒，默认为20秒。说明该参数传入0时，系统自动处理为默认值，即TCP协议为900秒，UDP协议为20秒。
ServerGroupId	String	是	rsp-bp1o94dp5i6ea****	监听器关联的服务器组 ID。您可以调用DescribeNLBServerGroups接口获取服务器组ID。
Description	String	否	This is a listener.	监听器的描述。必须以字母或中文开头，可包含数字、英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）长度限制为1 ～ 255个字符。该参数不传入，则默认为空字符串。
Tags.N.Key	String	否	Tags.1.Key=k1&Tags.2.Key=k2	用户标签的标签键。 N：表示标签信息的序号，需按照数字顺序从1开始填写，取值范围 1～20。多个标签键之间使用&分隔。长度限制为1～128个字符。大小写敏感，不能以`volc:`或`sys:`的任意大小写组合开头。不能以空格开头或结尾。允许包含字母、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。说明同一资源的标签键不允许重复。
Tags.N.Value	String	否	Tags.1.Value=v1&Tags.2.Value=v2	用户标签的标签值。 N：表示标签信息的序号，需按照数字顺序从1开始填写，取值范围 1～20。多个标签值之间使用&分隔。每个标签键对应一个标签值。长度限制为0～255个字符。大小写敏感，不能以空格开头或结尾。允许包含字母、数字、空格（）、下划线（_）、点号（.）、半角冒号（:）、斜杠（/）、等号（=）、加号（+）、减号（-）和@。说明如果传入该参数，则必须先传入`Tags.N.Key`。

返回参数

名称	类型	示例值	描述
RequestId	String	2024092952539010225146063030****	请求ID。
ListenerId	String	lsn-2fek3rgsxhrsw5oxruwec****	监听器ID。

请求示例

GET /?Action=CreateNLBListener&Version=2020-04-01&LoadBalancerId=nlb-bp1o94dp5i6ea****&Protocol=TCP&ServerGroupId=rsp-bp1o94dp5i6ea**** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-guangzhou
Service: clb

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024092952539010225146063030****",
        "Action": "CreateNLBListener",
        "Version": "2020-04-01",
        "Service": "clb",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "RequestId": "2024092952539010225146063030****",
        "ListenerId": "lsn-2fek3rgsxhrsw5oxruwec****"
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。