最近更新时间:2022.09.01 11:30:06
首次发布时间:2022.09.01 11:30:06
API 名称:DescribeListener 。
API 域名:open.volcengineapi.com 。
API 描述:查询监听。
在使用该部分 API 提交请求时必须包含以下 URI 参数。
除了 URI 参数,该 API 请求还需要包含签名参数。关于更多签名参数的信息,参见公共请求参数。
名称 | 类型 | 是否必选 | 格式 | 说明 |
---|---|---|---|---|
Action | string | 是 | [a-zA-Z]+ | API 名称。 |
Version | string | 是 | YYYY-MM-DD | API 版本信息。该参数的取值是 2022-03-01 。 |
在使用该 API 提交请求时,请求正文中可以包含的参数如下。
参数 | 类型 | 是否必选 | 参数说明 | 示例值 |
---|---|---|---|---|
ListenerId | string | 是 | 待查询的监听 ID 。 | ga-ghdasgh*** |
参数 | 类型 | 参数说明 | 示例 |
---|---|---|---|
RequestId | string | 请求ID。 | 20210816110638****2514606306AF947C |
Listener | Listener | 监听结构。 | 见 Listener 。 |
Listener
参数 | 类型 | 参数说明 | 示例 |
---|---|---|---|
ListenerId | string | 监听 ID 。 | lst-ghdasgh*** |
AcceleratorId | string | 加速器 ID 。 | ga-ghdasgh*** |
CreateTime | long | 创建监听的时间,时间戳 | 1643155486 |
Name | string | 监听的名称。 | test |
Protocol | string | 监听协议,具体支持:TCP、UDP。 | TCP |
State | string | 监听的状态,支持取值:
| active |
EnableAffinity | bool | 是否开启客户端亲和性,默认不开启,支持取值:
| false |
PortRanges | array of PortRange | 监听端口。 | 见 PortRange |
PortRange
参数 | 类型 | 参数说明 | 示例 |
---|---|---|---|
FromPort | int | 起始端口。 | 80 |
ToPort | int | 终止端口。 | 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" } }