获取监听器配置 DescribeListener--全球加速-火山引擎

文档中心

立即注册

导航

获取监听器配置 DescribeListener

最近更新时间：2025.05.16 11:59:46首次发布时间：2024.09.23 14:09:18

查询监听器配置详情。

请求说明

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

请求参数

Query

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

Body

参数名称	数据类型	是否必选	参数说明	示例
ListenerId	String	是	监听器 ID。	`listener-r7Toi7rWimjHzAcxxxxxxx`

返回参数

参数名称	数据类型	参数说明	示例
AcceleratorId	String	加速器 ID。	`accinstance-W7buMWttXNuWD7zYRxxxxx`
AccountID	String	当前用户账号 ID。	`21000xxxxx`
ListenerId	String	监听器 ID。	`listener-r7Toi7rWimjHzAcxxxxxx`
Name	String	监听器名称。	`listener-hk-https`
CreateTime	Integer	监听器创建时间，以 UNIX 时间戳格式表示。	`1717127658`
State	String	监听器状态。取值： `active`：运行中 `deleting`：删除中 `deploying`：配置中	`active`
Protocol	String	监听协议。取值： `TCP` `UDP`	`TCP`
PortRanges	Object[]	监听器端口范围集合。每个端口范围由一个起始端口和一个结束端口定义。
EndpointGroupIds	String[]	主终端节点组 ID 的列表。	`["endpointgroup-gqE4zQPYQaPe8WZxxxxxxx"]`
BackupEndpointGroupIds	String[]	备终端节点组 ID 的列表。	`["endpointgroup-G5rZGjHh93TrBE8xxxxxxx"]`
EnableAffinity	Boolean	是否启用客户端亲和性。取值： `true`：启用 `false`：不启用	`false`
DisableIsolateTCPNullConn	Boolean	是否禁用隔离 TCP 空连接。取值： `true`：禁用“隔离 TCP 空连接” `false`：启用“隔离 TCP 空连接”	`false`
DisablePreConnect	Boolean	是否禁用预连接。取值： `true`：禁用预连接 `false`：启用预连接	`false`
FixedSourceReturn	Object	固定转发 IP 相关配置。
IPAccess	Object	基于源 IP 地址的访问控制相关配置。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202505141405088B12163778794FE25002",
        "Action": "DescribeListener",
        "Version": "2022-03-01",
        "Service": "ga",
        "Region": "cn-north-1"
    },
    "Result": {
        "AcceleratorId": "accinstance-W7buMWttXNuWD7zxxxxxx",
        "ListenerId": "listener-r7Toi7rWimjHzAcxxxxxx",
        "CreateTime": 1744956167,
        "Name": "listener-hk-https",
        "Protocol": "TCP",
        "State": "active",
        "PortRanges": [
            {
                "FromPort": 80,
                "ToPort": 80
            }
        ],
        "EnableAffinity": false,
        "AccountID": "21000xxxxx",
        "EndpointGroupIds": [
            "endpointgroup-gqE4zQPYQaPe8WZxxxxxxx"
        ],
        "BackupEndpointGroupIds": [
            "endpointgroup-G5rZGjHh93TrBE8xxxxxxx"
        ],
        "IPAccess": {
            "Enable": false,
            "FilterType": "",
            "FilterList": []
        },
        "FixedSourceReturn": {
            "Enable": false,
            "GroupID": 0,
            "Cidrs": []
        }
    }
}