请求说明

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

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必填	示例值	描述
Action	String	是	`CreateListenerInOneStep`	要执行的操作，取值：`CreateListenerInOneStep`。
Version	String	是	`2022-03-01`	API 的版本，取值：`2022-03-01`。

Body

参数	类型	是否必填	示例值	描述
AcceleratorId	String	是	`accinstance-YfiSM6k5BspFcC4BaG****`	指定待创建监听器的加速器 ID。可通过调用 `ListAccelerators` 接口获取账号下的加速器 ID。
Name	String	否	`listener-hk-https`	设置监听器名称。
Protocol	String	是	`TCP`	指定监听协议。取值： `TCP`：TCP 协议。 `UDP`：UDP 协议。
PortRanges	Object[]	是		指定监听端口范围列表，每个元素由起始端口和结束端口组成。该列表不能为空，多个端口范围不能重复或重叠。注意 TCP 监听默认禁用端口 `22`、`5500`、`5609`、`65500`、`65501` 和 `65508`；UDP 监听默认禁用端口 `5609` 和 `65501`。
EndpointGroups	Object[]	是		指定主终端节点组列表，每个元素为一个主终端节点组配置。
BackupEndpointGroups	Object[]	否		指定备用终端节点组列表，每个元素为一个备用终端节点组配置。
EnableAffinity	Boolean	是	`false`	指定是否启用客户端亲和性，仅当 `Protocol` 为 `TCP` 时有效。
RouteRetry	Boolean	否	`false`	指定是否开启路由重试。
IPAccess	Object	否		基于源 IP 地址的访问控制配置。将 `Enable` 设置为 `true` 时，必须同时设置 `FilterType` 和 `FilterList`。
ListenerDomainName	String	否	`www.example.com`	监听域名。
ProtocolPortRanges	Object	否		指定按协议区分的端口范围配置，用于分别设置 HTTP 和 HTTPS 协议的端口范围。仅当 `AcceleratorId` 对应的加速器采用域名接入且使用非标准端口时配置。
DisablePreConnect	Boolean	否	`false`	指定是否禁用预连接。默认值为 `false`。
DisableIsolateTCPNullConn	Boolean	否	`false`	指定是否禁用隔离 TCP 空连接。默认值为 `false`。
FixedSourceReturn	Object	否		指定固定转发 IP 配置。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
ListenerId	String	`listener-kRcRXoTS4WccfHXVdv****`	新建监听器的 ID。
EndpointGroupIds	String[]	`["endpointgroup-pFJjvVR67ZTb4ZcW6T****"]`	新建主终端节点组的 ID 列表。
BackupEndpointGroupIds	String[]	`["endpointgroup-pFJjvVR67ZTb4ZcW6T****"]`	新建备用终端节点组的 ID 列表。

请求示例

POST https://ga.volcengine-api.com?Action=CreateListenerInOneStep&Version=2022-03-01
{
  "AcceleratorId": "accinstance-YfiSM6k5BspFcC4BaG****",
  "Name": "listener-hk-tcp",
  "Protocol": "TCP",
  "PortRanges": [
    {
      "FromPort": 80,
      "ToPort": 443
    }
  ],
  "EndpointGroups": [
    {
      "Region": "CN_North",
      "EndpointType": "public",
      "TrafficPercentage": 100,
      "EndpointConfigurations": [
        {
          "Type": "IP",
          "Endpoint": "203.0.113.1",
          "Weight": 1
        }
      ]
    }
  ],
  "EnableAffinity": true
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241018113823009131254189EB9449",
    "Action": "CreateListenerInOneStep",
    "Version": "2022-03-01",
    "Service": "ga",
    "Region": "cn-beijing"
  },
  "Result": {
    "ListenerId": "listener-kRcRXoTS4WccfHXVdv****",
    "EndpointGroupIds": [
      "endpointgroup-pFJjvVR67ZTb4ZcW6T****"
    ],
    "BackupEndpointGroupIds": [
      "endpointgroup-pFJjvVR67ZTb4ZcW6T****"
    ]
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码。

状态码	错误码	错误信息	说明
400	AcceleratorStateInvalid	The state of the accelerator is deploying.	加速器部署中，暂不支持该操作。
400	EndpointIPIsAccelerateIP	Endpoint IP is Accelerate IP.	终端节点 IP 与加速 IP 相同，请更换终端节点 IP。

最近更新时间：2026.09.23 16:20:53

这个页面对您有帮助吗？

有用

无用

全球加速

请求说明 #

请求参数 #

Query #

Body #

返回参数 #

请求示例 #

返回示例 #

错误码 #

请求说明

请求参数

Query

Body

返回参数

请求示例

返回示例

错误码