文档中心

DescribeEndpointGroup

最近更新时间：2022.09.01 11:30:06

首次发布时间：2022.09.01 11:30:06

API说明

API 名称：DescribeEndpointGroup。
API 域名：open.volcengineapi.com 。
API 描述：查询终端节点组的详细信息。

URI 参数

在使用该部分 API 提交请求时必须包含以下 URI 参数。

除了 URI 参数，该 API 请求还需要包含签名参数。关于更多签名参数的信息，参见公共请求参数。

名称	类型	是否必选	格式	说明
Action	string	是	[a-zA-Z]+	API 名称。
Version	string	是	YYYY-MM-DD	API 版本信息。该参数的取值是 2022-03-01 。

请求正文

在使用该 API 提交请求时，请求正文中可以包含的参数如下。

参数	类型	是否必选	参数说明	示例
EndpointGroupId	string	是	终端节点组 ID 。	epg-ghdasgh***
ListenerId	string	是	监听 ID 。	lst-ghasdhg

响应正文

参数	类型	参数说明	示例
EndpointGroup	array of EndpointGroup	终端节点组结构。	见 EndpointGroup

EndpointGroup

参数	类型	参数说明	示例
EndpointGroupId	string	终端节点组 ID 。	lst-ghdasgh***
AcceleratorId	string	加速实例 ID 。	ga-ghdasgh***
ListenerId	string	监听 ID 。	lst-ghdasgh***
Name	string	终端节点组的名称。	test
State	string	终端节点组状态，当前支持取值： active：正常。 deploying：配置中。	active
IsVolcSource	bool	后端服务部署是否在火山引擎上。支持取值： true：后端服务部署在火山引擎。 false：后端服务部署在非火山引擎。	true
KeepClientIP	bool	是否开启保持客户端源 IP 功能，默认不开启此功能，支持取值： true：开启。 false：不开启。	true
KeepClientIPMethod	string	获取客户端源 IP 的方法，为空代表关闭，支持取值： auto：仅支持TCP，通过TOA（TCP Option Address）传递客户端IP，后端服务无需做任何改动（仅适用于后端部署于火山引擎场景）。 ProxyProtocolV1：仅支持TCP，通过为报文添加Proxy Protocol v1报头（ASCII码格式）传递客户端源IP。 ProxyProtocolV2 ：支持TCP/UDP，通过报文添加Proxy Protocol v2报头（二进制格式）传递客户端源IP。	ProxyProtocolV1
HealthyConfig	array of HealthyConfig	配置健康检查。	见 HealthyConfig
HealthCheckStatus	String	健康检查状态，包括： disable：关闭 normal：正常 abnormal：异常 partiallyAbnormal：部分异常	disable
Region	string	终端节点组回源区域，包括：CN_NorthEast、 CN_North、 CN_East、CN_South、CN_Central、CN_NorthWest、CN_SouthWest、AP1。	CN_NorthEast
EndpointConfigurations	array of EndpointConfiguration	终端节点配置。	见 EndpointConfiguration
TrafficPercentage	string	终端节点组的流量调配比例，范围为1-100。	1

HealthyConfig

参数	类型	参数说明	示例
HealthCheckEnable	bool	是否开启健康检查，默认不开启，支持取值： true：开启。 false：不开启。	true
HealthCheckProtocol	string	健康检查协议，当前默认支持TCP协议。	TCP
HealthCheckPort	int	健康检查端口，端口范围为1~65535。	22
HealthResponseTimeOut	int	响应超时时间，默认3s，不支持修改。	3
HealthCheckInterval	int	健康检查时间间隔，范围为1～50秒，默认为2秒。	2
HealthyThreshold	int	健康检查健康阈值，即针对健康检查变化所需要的连续健康检查次数，范围2～10，默认为3次。	3

EndpointConfiguration

参数	类型	参数说明	示例
Type	string	终端节点类型。部署在非火山引擎时，终端节点支持： IP：自定义 IP 。 Domain：自定义域名。部署在火山引擎时，终端节点支持： EIP：火山引擎公网IP 。 ECS：火山引擎ECS实例，	IP
Endpoint	string	终端节点服务地址。	1.1.1.1
Weight	int	终端节点的流量分配权重，范围为1-100。	20
HealthCheckStatus	String	健康检查状态，具体包括： disable：关闭。 available：可用。 unavailable：不可用。	normal

示例

请求示例

POST https://open.volcengineapi.com/?Version=2022-03-01&Action=DescribeEndpointGroup&<其他公共请求参数>
{
    "EndpointGroupId": "endpointgroup-SrepziDuvvxyHkWkgjvn5Y",
    "ListenerId": "listener-yrGx4hbk8kUjENhWtRqKnP"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "202208061643100102252431390138557D",
        "Action": "DescribeEndpointGroup",
        "Version": "2022-03-01",
        "Service": "ga",
        "Region": "cn-north-1"
    },
    "Result": {
        "AcceleratorId": "accinstance-zGHoYhWixBusRXtM2pC2UH",
        "ListenerId": "listener-yrGx4hbk8kUjENhWtRqKnP",
        "EndpointGroupId": "endpointgroup-SrepziDuvvxyHkWkgjvn5Y",
        "Name": "test",
        "State": "need_generate",
        "EndpointConfigurations": [
            {
                "Type": "IP",
                "Endpoint": "1.1.1.1",
                "Weight": 20,
                "HealthCheckStatus": "available",
                "HealthCheckRecords": [
                    {
                        "Status": "available",
                        "Time": "2022-07-14 05:22:41"
                    }
                ]
            }
        ],
        "IsVolcSource": false,
        "KeepClientIP": true,
        "KeepClientIPMethod": "ProxyProtocolV1",
        "Region": "CN_North",
        "HealthCheckStatus": "disable",
        "HealthyConfig": {
            "HealthCheckEnable": false,
            "HealthCheckProtocol": "TCP",
            "HealthResponseTimeOut": 3,
            "HealthCheckInterval": 2,
            "HealthyThreshold": 3
        },
        "TrafficPercentage": 0
    }
}

API说明

URI 参数

请求正文

响应正文

示例

请求示例

响应示例

全球加速

DescribeEndpointGroup

API说明

URI 参数

请求正文

响应正文

示例

请求示例

响应示例