查询终端节点组列表ListEndpointGroups--全球加速-火山引擎

文档中心

立即注册

导航

查询终端节点组列表ListEndpointGroups

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

本接口用于查询终端节点组列表。

请求说明

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

请求参数

Query

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

Body

参数名称	数据类型	是否必选	参数说明	示例
ListenerId	String	是	监听器 ID 。	`listener-xxxx`
PageSize	Integer	否	分页查询时每页的行数。默认值：10。最大值：1000	`10`
PageNum	Integer	否	列表的页码，默认值为1。	`1`
AcceleratorId	String	否	标准型加速器 ID 。	`accelerator-xxxx`

返回参数

参数名称	数据类型	参数说明	示例
EndpointGroups	Object[]	该监听下的终端节点组列表。	`-`
PageNum	Integer	列表的页码。	`1`
PageSize	Integer	分页查询时每页的行数。	`10`
TotalCount	Integer	总数	`10`

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListEndpointGroups",
        "Version": "2022-03-01",
        "Service": "ga",
        "Region": "cn-north-1"
    },
    "Result": {
        "EndpointGroups": [
            {
                "AcceleratorId": "accelerator-xxxx",
                "ListenerId": "listener-xxxx",
                "EndpointGroupId": "endpointgroup-xxxx",
                "Name": "test",
                "State": "active",
                "Region": "CN_East",
                "TrafficPercentage": 100,
                "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"
                    }
                ]
            }
        ],
        "PageNum": 1,
        "PageSize": 10,
        "TotalCount": 1
    }
}