查询指定监听信息DescribeListener--全球加速-火山引擎

文档中心

立即注册

导航

查询指定监听信息DescribeListener

最近更新时间：2024.09.23 14:09:18首次发布时间：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-xxxx`

返回参数

参数名称	数据类型	参数说明	示例
AcceleratorId	String	标准型加速器ID。	`accinstance-xxxx`
ListenerId	String	监听器 ID 。	`listener-xxxx`
CreateTime	Integer	创建该监听的时间，用 Unix 时间戳表示。	`1717127658`
Name	String	该监听的名称。	`xxxx`
Protocol	String	该监听的协议，支持取值： TCP UDP	`TCP`
State	String	该监听的状态： active：运行中 deleting：删除中 deploying：配置中	`active`
PortRanges	Object[]	该监听配置的端口范围列表。	`-`
EnableAffinity	Boolean	该监听是否启用客户端亲和性。 true：启用。 false：未启用。	`true`

请求示例

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

返回示例

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