本接口用于获取监听器的详情。
下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。 其他公共参数,请参见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetLBListener | 公共参数。该参数表示接口名称。取值:GetLBListener |
Version | String | 是 | 2021-04-30 | 公共参数。该参数表示接口版本。取值:2021-04-30。 |
lb_identity | String | 是 | veew-lb2131011027612112**** | 负载均衡实例的 ID。您可以通过 ListLBs 接口查询负载均衡实例的 ID。 |
listen_port | Integer | 是 | 80 | 监听端口。 |
listen_port_protocol | String | 是 | TCP | 监听协议。取值范围:
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
listener | 请参见返回示例 | 监听器的详情。 |
GET https://veenedge.volcengineapi.com/?Action=GetLBListener&Version=2021-04-30 &lb_identity=veew-lb1047700072022322**** &listen_port=80 &listen_port_protocol=TCP &<其他公共参数>
{ "ResponseMetadata": { "RequestId": "20230531155759BB34000408E0BEA6****", "Action": "GetLBListener", "Version": "2021-04-30", "Service": "veenedge", "Region": "cn-north-1" }, "Result": { "listener": { "name": "listener-1", "listen_port_protocol": "TCP", "listen_port": 80, "loadbalance_strategy": "sip+sport", "desc": "", "endpoints": [], "health_check": { "protocol": "TCP", "port": 0, "timeout": 3, "period": 5, "failure_threshold": 3, "success_threshold": 3, "http_host": "", "http_path": "", "http_success_codes": "", "udp_check_string": "", "use_endpoint_port": true }, "create_time": 1682415025, "listener_uniq": "bd3f09f075b6af208afccca934fe****", "default_endpoint_port": 80 } } }
如果响应正文中包含 Error 字段,则表示 API 请求失败。关于错误码的更多信息,参见错误码。