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

文档中心

导航

ModifyNLBListenerAttributes

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

调用 ModifyNLBListenerAttributes 接口，修改监听器。

请求参数

下表中的可选参数如不配置，则保持原有取值不变。

名称	类型	是否必选	示例值	说明
Action	String	是	ModifyNLBListenerAttributes	要执行的操作，取值为ModifyNLBListenerAttributes。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
ListenerId	String	是	lsn-2fek3rgsxhrsw5oxruwec****	监听器ID。您可以调用DescribeNLBListeners接口获取监听器ID。
ListenerName	String	否	mylistener	监听器的名称。必须以字母、数字或中文开头，可包含以下特殊字符：点号（.）、下划线（_）和中划线（-）。长度限制在1 ～ 128字符之间。
ConnectionTimeout	Integer	否	800	监听器的连接超时时间。参数`Protocol`为“TCP”时，取值范围为10～900秒，默认为900秒。参数`Protocol`为“UDP”时，取值范围为10～120秒，默认为20秒。说明该参数传入0时，系统自动处理为默认值，即TCP协议为900秒，UDP协议为20秒。
Enabled	String	否	true	是否启用监听器。取值如下： true：开启。 false：关闭。
ServerGroupId	String	否	rsp-bp1o94dp5i6ea****	监听器关联的服务组ID。您可以调用DescribeNLBServerGroups接口获取服务器组ID。
Description	String	否	This is a listener.	监听器的描述。必须以字母或中文开头，可包含数字、英文逗号（,）、点号（.）、下划线（_）、空格（）、等号（=）、中划线（-）、中文逗号（，）、中文句号（。）长度限制为1 ～ 255个字符。

返回参数

名称	类型	示例值	描述
RequestId	String	2024092952539010225146063030****	请求ID。

请求示例

GET /?Action=ModifyNLBListenerAttributes&Version=2020-04-01&ListenerId=lsn-2fek3rgsxhrsw5oxruwec****&ListenerName=test HTTP/1.1
Host: open.volcengineapi.com
Region: cn-guangzhou
Service: clb

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024092952539010225146063030****",
        "Action": "ModifyNLBListenerAttributes",
        "Version": "2020-04-01",
        "Service": "clb",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "RequestId": "2024092952539010225146063030****"
    }
}

错误码

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