查询指定终端节点组DescribeEndpointGroup--全球加速-火山引擎

文档中心

立即注册

导航

查询指定终端节点组DescribeEndpointGroup

最近更新时间：2024.09.24 16:30:09首次发布时间：2024.09.24 16:30:09

本接口用于查询指定的终端节点组。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=DescribeEndpointGroup&Version=2022-03-01

请求参数

Query

参数名称	数据类型	是否必选	参数说明
Action	String	是	接口名称。当前 API 的名称为 `DescribeEndpointGroup`。
Version	String	是	接口版本。当前 API 的版本为 `2022-03-01`。

Body

参数名称	数据类型	是否必选	参数说明	示例
ListenerId	String	是	监听器ID。	`listener-xxxx`
EndpointGroupId	String	是	标准型加速器的终端节点组ID。	`endpointgroup-xxxx`

返回参数

参数名称	数据类型	参数说明	示例
AcceleratorId	String	标准型加速器 ID 。	`accelerator-xxxx`
ListenerId	String	监听器 ID。	`listener-xxxx`
EndpointGroupId	String	终端节点组 ID。	`endpointgroup-xxxx`
Name	String	终端节点组名称。	`test`
Region	String	终端节点组的区域。 CN_North：华北 CN_East：华东 CN_South：华南 CN_NorthEast：东北 CN_Central：华中 CN_NorthWest：西北 CN_SouthWest：西南 AP1：亚太1	`CN_East`
State	String	终端节点组状态： active：运行中 deleting：删除中 deploying：配置中	`active`
TrafficPercentage	Integer	流量调配权重，即本终端节点组接入的流量在所有终端节点组接入流量的比例。一个监听默认可以关联2个默认终端节点组，如果需要创建更多默认终端节点组，请联系客服经理。每个终端节点组的流量调配取值范围：1~100。	`1`
KeepClientIP	Boolean	是否开启了保持客户端源IP功能。 true：启用了保持客户端源IP功能。 false：未启用此功能。	`true`
KeepClientIPMethod	String	保持客户端源IP的方法： Proxy Protocol v1：仅在`Protocol`为`TCP`时有效。通过为报文添加Proxy Protocol v1报头（ASCII码格式）传递客户端源IP。 Proxy Protocol v2：通过报文添加 Proxy Protocol v2报头（二进制格式）传递客户端源IP。注意如果您的后端服务器不支持解析Proxy Protocol，则会导致后端服务器无法正确解析加速流量。	`Proxy Protocol v1`
EndpointType	String	终端节点类型，支持取值： public：公网 private：私网	`public`
SourceIP	Object[]	表示私网回源IP网段，仅在终端节点为私网类型时存在。	`-`
EndpointConfigurations	Object[]	终端节点的配置信息。	`-`
HealthyConfig	Object	健康检查的配置信息。	`-`
HealthCheckStatus	String	终端节点组的健康检查状态： detecting：探测中 disable：未开启 available：可用 unavailable：不可用 normal：正常 abnormal：异常 partiallyAbnormal：部分异常	`normal`

请求示例

POST https://open.volcengineapi.com?Action=DescribeEndpointGroup&Version=2022-03-01
{
    "EndpointGroupId": "endpointgroup-xxxx",
    "ListenerId": "listener-xxxx"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "DescribeEndpointGroup",
        "Version": "2022-03-01",
        "Service": "ga",
        "Region": "cn-north-1"
    },
    "Result": {
        "AcceleratorId": "accelerator-xxxx",
        "ListenerId": "listener-xxxx",
        "Region": "CN_East",
        "EndpointGroupId": "endpointgroup-xxxx",
        "Name": "test",
        "State": "active",
        "TrafficPercentage": 1,
        "HealthCheckStatus": "normal",
        "KeepClientIP": true,
        "KeepClientIPMethod": "Proxy Protocol v1",
        "EndpointType": "public",
        "HealthyConfig": {
            "HealthCheckEnable": true,
            "HealthCheckProtocol": "TCP",
            "HealthCheckPort": 80,
            "HealthResponseTimeOut": 2,
            "HealthCheckInterval": 2,
            "HealthyThreshold": 3
        },
        "EndpointConfigurations": [
            {
                "Type": "IP",
                "Endpoint": "1.1.1.1",
                "Weight": 1,
                "HealthCheckStatus": "normal"
            }
        ]
    }
}