查询监听列表ListListeners--全球加速-火山引擎

文档中心

立即注册

导航

查询监听列表ListListeners

最近更新时间：2024.09.23 11:40:37首次发布时间：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。	`accelerator-xxxx`
PageSize	Integer	否	分页查询时每页的行数。默认值：10。最大值：1000	`10`
PageNum	Integer	否	列表的页码，默认值为1。	`1`
State	String	否	按照监听器的状态进行查询，监听器的状态如下： active：运行中 deleting：删除中 deploying：配置中	`active`

返回参数

参数名称	数据类型	参数说明	示例
Listeners	Object[]	监听器列表信息。	`-`
PageNum	Integer	列表的页码，默认值为1。	`1`
PageSize	Integer	分页查询时每页的行数，默认为10。	`10`
TotalCount	Integer	监听器的总数。	`10`

请求示例

POST https://open.volcengineapi.com?Action=ListListeners&Version=2022-03-01
{
    "AcceleratorId": "accelerator-xxxx"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListListeners",
        "Version": "2022-03-01",
        "Service": "ga",
        "Region": "cn-north-1"
    },
    "Result": {
        "Listeners": [
            {
                "AcceleratorId": "accinstance-xxxx",
                "ListenerId": "listener-xxxx",
                "CreateTime": 1717127658,
                "Name": "xxxx",
                "Protocol": "TCP",
                "State": "active",
                "PortRanges": [
                    {
                        "FromPort": 80,
                        "ToPort": 80
                    }
                ],
                "EnableAffinity": true
            }
        ],
        "PageNum": 1,
        "PageSize": 10,
        "TotalCount": 10
    }
}