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

全球加速

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

查询指定终端节点组的区域、流量权重、终端节点、健康检查状态和源 IP 保持等配置。适用于检查监听器的后端回源和健康状态。

请求说明

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

请求参数

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

Query

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

Body

参数
类型
是否必填
示例值
描述
ListenerId
String
是
listener-kRcRXoTS4WccfHXVdv****
终端节点组所属的监听器 ID。可通过调用 ListListeners 接口获取指定加速器下的监听器 ID。
EndpointGroupId
String
是
endpointgroup-pFJjvVR67ZTb4ZcW6T****
要查询的终端节点组 ID。可通过调用 ListEndpointGroups 接口获取指定监听器下的终端节点组 ID。

返回参数

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

参数
类型
示例值
描述
AcceleratorId
String
accinstance-YfiSM6k5BspFcC4BaG****
加速器 ID。
Region
String
CN_North
终端节点组所在区域。取值：
  • CN_North：华北。
  • CN_East：华东。
  • CN_South：华南。
  • CN_NorthEast：东北。
  • CN_Central：华中。
  • CN_NorthWest：西北。
  • CN_SouthWest：西南。
  • AP1：亚太 1。
HealthCheckStatus
String
disable
终端节点组的健康检查状态。取值：
  • detecting：探测中。
  • disable：未开启。
  • available：可用。
  • unavailable：不可用。
  • normal：正常。
  • abnormal：异常。
  • partiallyAbnormal：部分异常。
HealthyConfig
Object
健康检查的配置信息。
TrafficPercentage
Integer
50
终端节点组的流量调配权重，表示其接入流量占全部终端节点组接入流量的比例。取值范围为 [1, 100]。
ListenerId
String
listener-kRcRXoTS4WccfHXVdv****
监听器 ID。
EndpointGroupId
String
endpointgroup-pFJjvVR67ZTb4ZcW6T****
终端节点组 ID。
Name
String
hk-web-cluster
终端节点组名称。
State
String
active
终端节点组的状态。取值：
  • active：运行中。
  • deleting：删除中。
  • deploying：配置中。
EndpointConfigurations
Object[]
终端节点组的终端节点配置列表，每个元素表示一个终端节点。
KeepClientIP
Boolean
true
是否开启基于 Proxy Protocol 的保持客户端源 IP 功能。
KeepClientIPMethod
String
Proxy Protocol v2
保持客户端源 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 网段列表，仅当终端节点组类型为 private 时返回。

请求示例 

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

返回示例 

{
  "ResponseMetadata": {
    "RequestId": "20241018155339175228250116DE7F6E",
    "Action": "DescribeEndpointGroup",
    "Version": "2022-03-01",
    "Service": "ga",
    "Region": "cn-beijing"
  },
  "Result": {
    "AcceleratorId": "accinstance-YfiSM6k5BspFcC4BaG****",
    "Region": "CN_East",
    "HealthCheckStatus": "normal",
    "HealthyConfig": {
      "HealthCheckEnable": true,
      "HealthCheckProtocol": "TCP",
      "HealthCheckPort": 80,
      "HealthResponseTimeOut": 2,
      "HealthCheckInterval": 10,
      "HealthyThreshold": 3
    },
    "TrafficPercentage": 1,
    "ListenerId": "listener-kRcRXoTS4WccfHXVdv****",
    "EndpointGroupId": "endpointgroup-pFJjvVR67ZTb4ZcW6T****",
    "Name": "web-endpoint-group",
    "State": "active",
    "EndpointConfigurations": [
      {
        "Type": "IP",
        "Endpoint": "203.0.113.99",
        "Weight": 1
      }
    ],
    "KeepClientIP": true,
    "KeepClientIPMethod": "Proxy Protocol v1",
    "EndpointType": "public",
    "SourceIP": [
      {
        "IPRange": "10.0.0.0/8",
        "IPRangeId": "ip-xxx"
      }
    ]
  }
}

错误码

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

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