You need to enable JavaScript to run this app.
文档中心
全球加速

全球加速

请输入
  • 文档首页
    • 全球加速API参考标准型加速器-终端节点组接口新增终端节点组 CreateEndpointGroup
复制全文
下载 pdf
我的收藏
标准型加速器-终端节点组接口
新增终端节点组 CreateEndpointGroup
复制全文
下载 pdf
我的收藏
新增终端节点组 CreateEndpointGroup

在指定监听器下创建终端节点组，并配置区域、流量权重、终端节点和健康检查等回源策略。创建成功后返回终端节点组 ID，可用于后续查询、更新或删除。

请求说明

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

请求参数

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

Query

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

Body

参数
类型
是否必填
示例值
描述
AcceleratorId
String
是
accinstance-YfiSM6k5BspFcC4BaG****
指定与终端节点组关联的加速器 ID。可通过调用 ListAccelerators 接口获取账号下的加速器 ID。
ListenerId
String
是
listener-kRcRXoTS4WccfHXVdv****
指定与终端节点组关联的监听器 ID。可通过调用 ListListeners 接口获取指定加速器下的监听器 ID。
Region
String
是
CN_East
指定终端节点组所在区域。取值：
  • CN_North：华北。
  • CN_East：华东。
  • CN_South：华南。
  • CN_NorthEast：东北。
  • CN_Central：华中。
  • CN_NorthWest：西北。
  • CN_SouthWest：西南。
  • AP1：亚太 1。
Name
String
否
test-name
指定终端节点组的名称。
TrafficPercentage
Integer
是
1
指定本终端节点组的流量调配权重，即本终端节点组接入的流量占所有终端节点组接入流量的比例，取值范围为 [1, 100]。一个监听器默认可关联 2 个终端节点组，如需创建更多，请联系客服经理。
KeepClientIP
Boolean
是
true
指定是否开启基于 Proxy Protocol 的保持客户端源 IP 功能。
KeepClientIPMethod
String
否
Proxy Protocol v1
指定保持客户端源 IP 的实现方式。当前已知取值：
  • Proxy Protocol v1：仅在监听协议为 TCP 时有效；通过在 TCP 报文 Payload 开头添加 Proxy Protocol v1 头部（ASCII 编码格式）传递客户端源 IP。
  • Proxy Protocol v2：通过在 TCP 或 UDP 报文 Payload 开头添加 Proxy Protocol v2 头部（二进制格式）传递客户端源 IP。

注意

后端应用必须支持 Proxy Protocol，才能解析包含该头部的流量。

EndpointType
String
否
public
指定终端节点类型。取值：
  • public：公网。
  • private：私网。

默认值为 public。
EndpointConfigurations
Object[]
是
指定终端节点组的终端节点配置列表，每个元素为一个终端节点配置。
HealthyConfig
Object
是
指定终端节点组的健康检查配置。
SourceIP
Object[]
是
指定私网回源 IP 网段，仅在终端节点为私网类型时必填，每个元素为一个回源网段配置。

返回参数

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

参数
类型
示例值
描述
EndpointGroupId
String
endpointgroup-pFJjvVR67ZTb4ZcW6T****
新建终端节点组的唯一标识，后续查询、更新或删除终端节点组时作为入参。

请求示例 

POST https://ga.volcengine-api.com?Action=CreateEndpointGroup&Version=2022-03-01
{
  "AcceleratorId": "accinstance-YfiSM6k5BspFcC4BaG****",
  "ListenerId": "listener-kRcRXoTS4WccfHXVdv****",
  "Region": "CN_North",
  "Name": "test-name",
  "TrafficPercentage": 1,
  "KeepClientIP": true,
  "KeepClientIPMethod": "Proxy Protocol v1",
  "EndpointType": "public",
  "EndpointConfigurations": [
    {
      "Type": "IP",
      "Endpoint": "203.0.113.1",
      "Weight": 1
    }
  ],
  "HealthyConfig": {
    "HealthCheckEnable": true,
    "HealthCheckProtocol": "TCP",
    "HealthCheckInterval": 10,
    "HealthyThreshold": 3,
    "HealthResponseTimeOut": 10,
    "HealthCheckPort": 80
  },
  "SourceIP": [
    {
      "IPRange": "10.0.0.0/8",
      "IPRangeId": "ip-xxx"
    }
  ]
}

返回示例 

{
  "ResponseMetadata": {
    "RequestId": "202410181535302031611120303D223A",
    "Action": "CreateEndpointGroup",
    "Version": "2022-03-01",
    "Service": "ga",
    "Region": "cn-beijing"
  },
  "Result": {
    "EndpointGroupId": "endpointgroup-pFJjvVR67ZTb4ZcW6T****"
  }
}

错误码

本接口无专用错误码。公共错误码请参见公共错误码。

最近更新时间：2026.09.23 16:20:53
这个页面对您有帮助吗？
有用
有用
无用
无用