请求说明

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

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必填	示例值	描述
Action	String	是	`ListListeners`	要执行的操作，取值：`ListListeners`。
Version	String	是	`2022-03-01`	API 的版本，取值：`2022-03-01`。

Body

参数	类型	是否必填	示例值	描述
AcceleratorId	String	是	`accinstance-YfiSM6k5BspFcC4BaG****`	指定待查询监听器所属的加速器 ID。
PageSize	Integer	否	`10`	分页查询时每页返回的最大条目数。默认值为 `10`，最大值为 `1000`。
PageNum	Integer	否	`1`	分页查询的页码。默认值为 `1`。
State	String	否	`active`	按监听器状态筛选，仅返回指定状态的监听器。取值： `active`：运行中。 `deleting`：删除中。 `deploying`：配置中。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Listeners	Object[]		查询到的监听器列表。
PageNum	Integer	`1`	本次返回结果的页码。
PageSize	Integer	`10`	返回结果中每页的条目数。
TotalCount	Integer	`20`	符合查询条件的监听器总数。

请求示例

POST https://ga.volcengine-api.com?Action=ListListeners&Version=2022-03-01
{
  "AcceleratorId": "accinstance-YfiSM6k5BspFcC4BaG****",
  "PageSize": 10,
  "PageNum": 1
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250515114506B557F599A5445744E096",
    "Action": "ListListeners",
    "Version": "2022-03-01",
    "Service": "ga",
    "Region": "cn-beijing"
  },
  "Result": {
    "Listeners": [
      {
        "AcceleratorId": "accinstance-YfiSM6k5BspFcC4BaG****",
        "AccountID": "210005XXXX",
        "ListenerId": "listener-J8mQ2rV7KsP4xNf6Tb****",
        "Name": "TCP-test",
        "CreateTime": 1747279427,
        "State": "active",
        "Protocol": "TCP",
        "PortRanges": [
          {
            "FromPort": 9999,
            "ToPort": 9999
          },
          {
            "FromPort": 10001,
            "ToPort": 10003
          }
        ],
        "EndpointGroupIds": [
          "endpointgroup-7gxZsp6gEYrnRwK****"
        ],
        "BackupEndpointGroupIds": [],
        "EnableAffinity": false,
        "DisableIsolateTCPNullConn": false,
        "DisablePreConnect": false,
        "FixedSourceReturn": {
          "Enable": false
        },
        "IPAccess": {
          "Enable": true,
          "FilterType": "WhiteList",
          "FilterList": [
            "198.51.100.0/24"
          ]
        }
      },
      {
        "AcceleratorId": "accinstance-YfiSM6k5BspFcC4BaG****",
        "AccountID": "210005XXXX",
        "ListenerId": "listener-kRcRXoTS4WccfHXVdv****",
        "Name": "udp-test",
        "CreateTime": 1744956167,
        "State": "active",
        "Protocol": "UDP",
        "PortRanges": [
          {
            "FromPort": 8888,
            "ToPort": 8888
          }
        ],
        "EndpointGroupIds": [
          "endpointgroup-pFJjvVR67ZTb4ZcW6T****"
        ],
        "BackupEndpointGroupIds": [],
        "EnableAffinity": false,
        "FixedSourceReturn": {
          "Enable": false
        },
        "IPAccess": {
          "Enable": true,
          "FilterType": "WhiteList",
          "FilterList": [
            "198.51.100.0/24"
          ]
        }
      }
    ],
    "PageNum": 1,
    "PageSize": 10,
    "TotalCount": 2
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码。

状态码	错误码	错误信息	说明
400	AcceleratorNotExist	The accelerated instance does not exist.	指定的加速器不存在，请确认加速器 ID 后重试。

最近更新时间：2026.09.23 16:20:53

这个页面对您有帮助吗？

有用

无用

全球加速

请求说明 #

请求参数 #

Query #

Body #

返回参数 #

请求示例 #

返回示例 #

错误码 #

请求说明

请求参数

Query

Body

返回参数

请求示例

返回示例

错误码