更新指定监听器的协议、端口、名称、客户端亲和性、访问控制及连接相关配置。适用于调整监听器接收和转发的流量范围。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
Action | String | 是 | UpdateListener | 要执行的操作,取值: UpdateListener。 |
Version | String | 是 | 2022-03-01 | API 的版本,取值: 2022-03-01。 |
参数 | 类型 | 是否必填 | 示例值 | 描述 |
|---|---|---|---|---|
AcceleratorId | String | 是 | accinstance-YfiSM6k5BspFcC4BaG**** | 指定需修改监听器所属加速器的 ID。可通过调用 ListAccelerators 接口获取加速器 ID。 |
ListenerId | String | 是 | listener-kRcRXoTS4WccfHXVdv**** | 指定需修改的监听器 ID。可通过调用 ListListeners 接口获取指定加速器下的监听器 ID。 |
Name | String | 否 | listener-hk-https | 设置监听器名称。 |
Protocol | String | 否 | TCP | 指定监听协议。取值:
|
PortRanges | Object[] | 是 | 指定监听端口范围列表,每个元素由起始端口和结束端口组成。 | |
EnableAffinity | Boolean | 是 | false | 指定是否启用客户端亲和性,仅当 Protocol 为 TCP 时有效。 |
DisableIsolateTCPNullConn | Boolean | 否 | false | 指定是否禁用隔离 TCP 空连接。默认值为 false。 |
DisablePreConnect | Boolean | 否 | false | 指定是否禁用预连接。默认值为 false。 |
FixedSourceReturn | Object | 否 | 指定固定转发 IP 配置。 | |
IPAccess | Object | 否 | 基于源 IP 地址的访问控制配置。将 Enable 设置为 true 时,必须同时设置 FilterType 和 FilterList。 |
本接口无专有返回参数。返回参数结构信息,请参见返回结构。
POST https://ga.volcengine-api.com?Action=UpdateListener&Version=2022-03-01 { "AcceleratorId": "accinstance-YfiSM6k5BspFcC4BaG****", "ListenerId": "listener-kRcRXoTS4WccfHXVdv****", "Name": "listener-hk-https", "Protocol": "TCP", "PortRanges": [ { "FromPort": 80, "ToPort": 80 } ], "EnableAffinity": false, "DisableIsolateTCPNullConn": false, "DisablePreConnect": false, "FixedSourceReturn": { "Enable": false }, "IPAccess": { "Enable": true, "FilterType": "WhiteList", "FilterList": [ "198.51.100.0/24" ] } }
{ "ResponseMetadata": { "RequestId": "20250515195135B9B303FCBA7E837D5EF5", "Action": "UpdateListener", "Version": "2022-03-01", "Service": "ga", "Region": "cn-beijing" }, "Result": {} }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码。
状态码 | 错误码 | 说明 |
|---|---|---|
400 | GAInnerError | 服务内部错误,请稍后重试。 |