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

文档中心

立即注册

导航

一键创建监听和终端节点组CreateListenerInOneStep

最近更新时间：2024.09.24 17:29:15首次发布时间：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 。	`accelerator-xxxx`
Name	String	否	标准型加速器名称。	`xxxx`
Protocol	String	是	监听协议，支持取值： TCP UDP	`TCP`
PortRanges	Object[]	是	监听端口的范围。多个端口之间使用半角逗号`,`分隔。输入一个端口号时，起始端口`FromPort`与结束端口`ToPort`相同。输入一个范围的端口时，`FromPort`表示起始端口，`ToPort`表示结束端口。允许端口、端口范围的混合输入，但是两者不可出现重复的端口号。	`-`
EnableAffinity	Boolean	是	是否开启客户端亲和性，仅在 Protocol 为 TCP 时有效。支持取值： true：开启此功能，如果客户端访问有状态的应用程序，同一个客户端的所有请求将被定向到同一终端节点，而不考虑源端口和协议。 false：不开启此功能。	`true`
EndpointGroups	Object[]	是	终端节点组列表。	`-`

返回参数

参数名称	数据类型	参数说明	示例
ListenerId	String	监听器ID。	`listener-xxxx`
EndpointGroupIds	String[]	终端节点组 ID 列表。	`["xx"]`

请求示例

POST https://open.volcengineapi.com?Action=CreateListenerInOneStep&Version=2022-03-01
{
    "AcceleratorId": "accelerator-xxxx",
    "Protocol": "TCP",
    "PortRanges": [
        {
            "FromPort": 80,
            "ToPort": 85
        }
    ],
    "EnableAffinity": true,
    "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-xxxx",
        "EndpointGroupIds": [
            "xx"
        ]
    }
}