修改监听器配置 UpdateListener--全球加速-火山引擎

文档中心

立即注册

导航

修改监听器配置 UpdateListener

最近更新时间：2025.05.16 11:59:46首次发布时间：2024.09.23 11:40:37

修改监听器的配置。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=UpdateListener&Version=2022-03-01

请求参数

Query

参数名称	数据类型	是否必选	参数说明
Action	String	是	接口名称。当前 API 的名称为 `UpdateListener`。
Version	String	是	接口版本。当前 API 的版本为 `2022-03-01`。

Body

参数名称	数据类型	是否必选	参数说明	示例
AcceleratorId	String	否	加速器 ID。	`accinstance-W7buMWttXNuWD7zYRxxxxx`
ListenerId	String	是	需要修改的监听器的 ID。	`listener-r7Toi7rWimjHzAcxxxxxx`
Name	String	否	监听器名称。	`listener-hk-https`
Protocol	String	否	监听协议。取值： `TCP` `UDP`	`TCP`
PortRanges	Object[]	否	监听器端口范围集合。每个端口范围由一个起始端口和一个结束端口定义。
EnableAffinity	Boolean	否	是否启用客户端亲和性。取值： `true`：启用 `false`：不启用	`false`
DisableIsolateTCPNullConn	Boolean	否	是否禁用隔离 TCP 空连接。取值： `true`：禁用“隔离 TCP 空连接” `false`：启用“隔离 TCP 空连接”	`false`
DisablePreConnect	Boolean	否	是否禁用预连接。取值： `true`：禁用预连接 `false`：启用预连接	`false`
FixedSourceReturn	Object	否	固定转发 IP 相关配置。
IPAccess	Object	否	基于源 IP 地址的访问控制相关配置。

返回参数

由于该 API 没有响应参数，响应正文只有包含请求元数据的 ResponseMetadata 结构体，没有 Result 结构体。

请求示例

POST https://open.volcengineapi.com?Action=UpdateListener&Version=2022-03-01
{
    "ListenerId": "listener-r7Toi7rWimjHzAcxxxxxx",
    "Protocol": "TCP",
    "Name": "listener-hk-https",
    "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-north-01"
    }
}