获取监听器列表 ListListeners--全球加速-火山引擎

文档中心

立即注册

导航

获取监听器列表 ListListeners

最近更新时间：2025.05.16 11:59:46首次发布时间：2024.09.23 11:40:37

查询标准型加速器上的所有监听器的配置详情。

请求说明

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

请求参数

Query

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

Body

参数名称	数据类型	是否必选	参数说明	示例
AcceleratorId	String	是	加速器 ID。	`accinstance-W7buMWttXNuWD7zYRxxxxx`
PageSize	Integer	否	每个分页显示的最大条目数。默认值：10。	`10`
PageNum	Integer	否	需要返回分页的序号。1 表示第一个分页。默认值：1。	`1`
State	String	否	基于监听器状态的筛选。仅返回指定状态的监听器。取值： `active`：运行中 `deleting`：删除中 `deploying`：配置中	`active`

返回参数

参数名称	数据类型	参数说明
Listeners	Object[]	监听器列表。
PageNum	Integer	页码
PageSize	Integer	返回分页的序号。
TotalCount	Integer	总条目数，即为该加速器上所有监听器的数量。

请求示例

POST https://open.volcengineapi.com?Action=ListListeners&Version=2022-03-01
{
    "AcceleratorId": "accinstance-W7buMWttXNuWD7zxxxxxxx",
    "PageSize": 10,
    "PageNum": 1
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20250515114506B557F599A5445744E096",
        "Action": "ListListeners",
        "Version": "2022-03-01",
        "Service": "ga",
        "Region": "cn-north-1"
    },
    "Result": {
        "Listeners": [
            {
                "AcceleratorId": "accinstance-W7buMWttXNuWD7zxxxxxxx",
                "ListenerId": "listener-hhZPtZBLaCahEyaxxxxxxx",
                "CreateTime": 1747279427,
                "Name": "TCP-test",
                "Protocol": "TCP",
                "State": "active",
                "PortRanges": [
                    {
                        "FromPort": 9999,
                        "ToPort": 9999
                    },
                    {
                        "FromPort": 10001,
                        "ToPort": 10003
                    }
                ],
                "EnableAffinity": false,
                "AccountID": "21000xxxxx",
                "BandwidthScalingFactor": 0,
                "EndpointGroupIds": [
                    "endpointgroup-7gxZsp6gEYrnRwKxxxxxxx"
                ],
                "IPAccess": {
                    "Enable": false,
                    "FilterType": "",
                    "FilterList": []
                },
                "ListenerDomainName": "",
                "DisablePreConnect": false,
                "DisableIsolateTCPNullConn": false,
                "FixedSourceReturn": {
                    "Enable": false,
                    "GroupID": 0,
                    "Cidrs": []
                }
            },
            {
                "AcceleratorId": "accinstance-W7buMWttXNuWD7zxxxxxxx",
                "ListenerId": "listener-r7Toi7rWimjHzAcxxxxxxx",
                "CreateTime": 1744956167,
                "Name": "udp-test",
                "Protocol": "UDP",
                "State": "active",
                "PortRanges": [
                    {
                        "FromPort": 8888,
                        "ToPort": 8888
                    }
                ],
                "EnableAffinity": false,
                "AccountID": "21000xxxxx",
                "BandwidthScalingFactor": 0,
                "EndpointGroupIds": [
                    "endpointgroup-gqE4zQPYQaPe8WZxxxxxxx"
                ],
                "IPAccess": {
                    "Enable": false,
                    "FilterType": "",
                    "FilterList": []
                },
                "ListenerDomainName": "",
                "FixedSourceReturn": {
                    "Enable": false,
                    "GroupID": 0,
                    "Cidrs": []
                }
            }
        ],
        "TotalCount": 2,
        "PageSize": 10,
        "PageNum": 1
    }
}