You need to enable JavaScript to run this app.
文档中心
全球加速

全球加速

请输入
  • 文档首页
    • 全球加速API参考标准型加速器-监听接口获取监听器配置 DescribeListener
复制全文
下载 pdf
我的收藏
标准型加速器-监听接口
获取监听器配置 DescribeListener
复制全文
下载 pdf
我的收藏
获取监听器配置 DescribeListener

查询指定监听器的协议、端口、状态、客户端亲和性、访问控制及关联终端节点组。适用于检查监听器当前的流量接收和转发配置。

请求说明

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

请求参数

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

Query

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

Body

参数
类型
是否必填
示例值
描述
ListenerId
String
是
listener-kRcRXoTS4WccfHXVdv****
待查询的监听器 ID。可通过调用 ListListeners 接口获取指定加速器下的监听器 ID。

返回参数

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

参数
类型
示例值
描述
AcceleratorId
String
accinstance-YfiSM6k5BspFcC4BaG****
加速器 ID。
AccountID
String
210005XXXX
当前用户账号 ID。
ListenerId
String
listener-kRcRXoTS4WccfHXVdv****
监听器 ID。
Name
String
listener-hk-https
监听器名称。
CreateTime
Integer
1717127658
监听器创建时间，以 Unix 秒级时间戳表示。
State
String
active
监听器状态。取值：
  • active：运行中。
  • deleting：删除中。
  • deploying：配置中。
Protocol
String
TCP
监听协议。取值：
  • TCP：TCP 协议。
  • UDP：UDP 协议。
PortRanges
Object[]
监听器端口范围集合。每个端口范围由一个起始端口和一个结束端口定义。
EndpointGroupIds
String[]
["endpointgroup-pFJjvVR67ZTb4ZcW6T****"]
监听器关联的主终端节点组 ID 列表。
BackupEndpointGroupIds
String[]
["endpointgroup-pFJjvVR67ZTb4ZcW6T****"]
监听器关联的备用终端节点组 ID 列表。
EnableAffinity
Boolean
false
是否启用客户端亲和性。仅当监听协议为 TCP 时有效。
DisableIsolateTCPNullConn
Boolean
false
是否已禁用隔离 TCP 空连接。
DisablePreConnect
Boolean
false
是否已禁用预连接。
FixedSourceReturn
Object
固定转发 IP 配置。
IPAccess
Object
基于源 IP 地址的访问控制配置。

请求示例 

POST https://ga.volcengine-api.com?Action=DescribeListener&Version=2022-03-01
{
  "ListenerId": "listener-kRcRXoTS4WccfHXVdv****"
}

返回示例 

{
  "ResponseMetadata": {
    "RequestId": "202505141405088B12163778794FE25002",
    "Action": "DescribeListener",
    "Version": "2022-03-01",
    "Service": "ga",
    "Region": "cn-beijing"
  },
  "Result": {
    "AcceleratorId": "accinstance-YfiSM6k5BspFcC4BaG****",
    "AccountID": "210005XXXX",
    "ListenerId": "listener-kRcRXoTS4WccfHXVdv****",
    "Name": "listener-hk-https",
    "CreateTime": 1744956167,
    "State": "active",
    "Protocol": "TCP",
    "PortRanges": [
      {
        "FromPort": 80,
        "ToPort": 80
      }
    ],
    "EndpointGroupIds": [
      "endpointgroup-pFJjvVR67ZTb4ZcW6T****"
    ],
    "BackupEndpointGroupIds": [
      "endpointgroup-pFJjvVR67ZTb4ZcW6T****"
    ],
    "EnableAffinity": false,
    "FixedSourceReturn": {
      "Enable": false
    },
    "IPAccess": {
      "Enable": true,
      "FilterType": "WhiteList",
      "FilterList": [
        "198.51.100.0/24"
      ]
    }
  }
}

错误码

本接口无专用错误码。公共错误码请参见公共错误码。

最近更新时间：2026.09.23 16:20:53
这个页面对您有帮助吗？
有用
有用
无用
无用