You need to enable JavaScript to run this app.
导航

DescribeListener

最近更新时间2022.09.01 11:30:06

首次发布时间2022.09.01 11:30:06

API 说明

API 名称:DescribeListener 。
API 域名:open.volcengineapi.com 。
API 描述:查询监听。

URI 参数

在使用该部分 API 提交请求时必须包含以下 URI 参数。

除了 URI 参数,该 API 请求还需要包含签名参数。关于更多签名参数的信息,参见公共请求参数

名称类型是否必选格式说明
Action
string
[a-zA-Z]+
API 名称。
VersionstringYYYY-MM-DDAPI 版本信息。该参数的取值是 2022-03-01 。

请求正文

在使用该 API 提交请求时,请求正文中可以包含的参数如下。

参数类型是否必选参数说明示例值
ListenerId
string
待查询的监听 ID 。
ga-ghdasgh***

响应正文

参数类型参数说明示例
RequestId
string
请求ID。
20210816110638****2514606306AF947C
ListenerListener监听结构。Listener

Listener

参数类型参数说明示例
ListenerId
string
监听 ID 。
lst-ghdasgh***
AcceleratorIdstring加速器 ID 。ga-ghdasgh***
CreateTimelong创建监听的时间,时间戳1643155486
Namestring监听的名称。test
Protocolstring监听协议,具体支持:TCP、UDP。TCP

State

string

监听的状态,支持取值:

  • active:正常。
  • deploying:配置中。
  • Inactive:待配置。

active

EnableAffinity

bool

是否开启客户端亲和性,默认不开启,支持取值:

  • true:开启。
  • false:不开启。

false

PortRangesarray of PortRange监听端口。PortRange

PortRange

参数类型参数说明示例
FromPort
int
起始端口。
80
ToPortint终止端口。81

示例

请求示例

POST https://open.volcengineapi.com/?Version=2022-03-01&Action=DescribeListener&<其他公共请求参数>
{
    "ListenerId": "listener-jvzT9jmfLYV7xdZ9wPLHcZ"
}

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20220806163155010225243139013774C2",
        "Action": "DescribeListener",
        "Version": "2022-03-01",
        "Service": "ga",
        "Region": "cn-north-1"
    },
    "Result": {
        "AcceleratorId": "accinstance-zGHoYhWixBusRXtM2pC2UH",
        "ListenerId": "listener-BBL7ACekxpY94mvkExYwMb",
        "CreateTime": 1654683362,
        "Name": "",
        "Protocol": "UDP",
        "State": "active",
        "PortRanges": [
            {
                "FromPort": 34,
                "ToPort": 34
            }
        ],
        "EnableAffinity": false,
        "AccountID": "2100055193"
    }
}