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

全球加速

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

更新指定终端节点组的区域、流量权重、终端节点、健康检查和源 IP 保持等配置。适用于后端资源变更、流量比例调整或健康检查策略调整。

请求说明

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

请求参数

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

Query

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

Body

参数
类型
是否必填
示例值
描述
AcceleratorId
String
是
accinstance-YfiSM6k5BspFcC4BaG****
指定需要更新的加速器 ID。可通过调用 ListAccelerators 接口获取加速器 ID。
ListenerId
String
是
listener-kRcRXoTS4WccfHXVdv****
指定包含该终端节点组的监听器 ID。可通过调用 ListListeners 接口获取指定加速器下的监听器 ID。
EndpointGroupId
String
是
endpointgroup-pFJjvVR67ZTb4ZcW6T****
指定待更新的终端节点组 ID。可通过调用 ListEndpointGroups 接口获取指定监听器下的终端节点组 ID。
Name
String
否
endpoint-group-01
设置终端节点组的名称。
Region
String
否
CN_East
设置终端节点组所在区域。取值：
  • CN_North：华北。
  • CN_East：华东。
  • CN_South：华南。
  • CN_NorthEast：东北。
  • CN_Central：华中。
  • CN_NorthWest：西北。
  • CN_SouthWest：西南。
  • AP1：亚太 1。
TrafficPercentage
Integer
否
1
设置终端节点组的流量调配权重，表示该组接入流量占全部终端节点组接入流量的比例。取值范围为 [1, 100]。
KeepClientIP
Boolean
否
true
指定是否开启基于 Proxy Protocol 的保持客户端源 IP 功能。
KeepClientIPMethod
String
否
Proxy Protocol v1
指定保持客户端源 IP 的方式。取值：
  • Proxy Protocol v1：仅在监听协议为 TCP 时有效；通过在报文中添加 ASCII 编码的 Proxy Protocol v1 报头传递客户端源 IP。
  • Proxy Protocol v2：通过在报文中添加二进制编码的 Proxy Protocol v2 报头传递客户端源 IP。

注意

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

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

返回参数

本接口无专有返回参数。返回参数结构信息，请参见返回结构。

请求示例 

POST https://ga.volcengine-api.com?Action=UpdateEndpointGroup&Version=2022-03-01
{
  "AcceleratorId": "accinstance-YfiSM6k5BspFcC4BaG****",
  "ListenerId": "listener-kRcRXoTS4WccfHXVdv****",
  "EndpointGroupId": "endpointgroup-pFJjvVR67ZTb4ZcW6T****",
  "TrafficPercentage": 1
}

返回示例 

{
  "ResponseMetadata": {
    "RequestId": "202306041104201234100232280022D31",
    "Action": "UpdateEndpointGroup",
    "Version": "2022-03-01",
    "Service": "ga",
    "Region": "cn-beijing"
  },
  "Result": {}
}

错误码

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

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