创建监听器和终端节点组 CreateListenerInOneStep--全球加速-火山引擎

文档中心

立即注册

导航

创建监听器和终端节点组 CreateListenerInOneStep

最近更新时间：2025.05.19 14:36:54首次发布时间：2024.09.23 11:40:37

创建监听器并配置终端节点组。

请求说明

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

请求参数

Query

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

Body

参数名称	数据类型	是否必选	参数说明	示例
AcceleratorId	String	是	加速器 ID。	`accinstance-W7buMWttXNuWD7zYRxxxxx`
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 地址的访问控制相关配置。
EndpointGroups	Object[]	否	主终端节点组列表。
BackupEndpointGroups	Object[]	否	备用终端节点组列表

返回参数

参数名称	数据类型	参数说明	示例
ListenerId	String	新建的监听器 ID。	`listener-r7Toi7rWimjHzAcxxxxxx`
EndpointGroupIds	String[]	新建的主终端节点组 ID 列表	`["endpointgroup-fDMGjUkXX9xM4Ljxxxxxxx"]`
BackupEndpointGroupIds	String[]	新建的备终端节点组 ID 列表。

请求示例

POST https://open.volcengineapi.com?Action=CreateListenerInOneStep&Version=2022-03-01
{
    "AcceleratorId": "accinstance-W7buMWttXNuWD7zYRxxxxx",
    "Protocol": "TCP",
    "PortRanges": [
        {
            "FromPort": 80,
            "ToPort": 80
        }
    ],
    "EndpointGroups": [
        {
            "Region": "CN_East",
            "EndpointType": "public",
            "TrafficPercentage": 100,
            "KeepClientIP": false,
            "HealthyConfig": {
                "HealthCheckEnable": false
            },
            "EndpointConfigurations": [
                {
                    "Type": "IP",
                    "Endpoint": "1.1.1.1",
                    "Weight": 1
                }
            ]
        }
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CreateListenerInOneStep",
        "Version": "2022-03-01",
        "Service": "ga",
        "Region": "cn-north-1"
    },
    "Result": {
        "ListenerId": "listener-r7Toi7rWimjHzAcxxxxxx",
        "EndpointGroupIds": [
            "endpointgroup-fDMGjUkXX9xM4Ljxxxxxxx"
        ]
    }
}