查询负载均衡监听列表详情。
接口说明
-
您已经创建了传统型负载均衡实例。具体操作,请参见 CreateLoadBalancer 。
-
您已经为创建的传统型负载均衡实例配置了监听。具体操作,请参见:
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
slb:DescribeLoadBalancerListeners | get |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 否 | 传统型负载均衡实例所在的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 说明
当您所选地域的 Endpoint(服务地址)为 slb.aliyuncs.com 时, RegionId 必填。
| cn-hangzhou |
NextToken | string | 否 | 是否拥有下一次查询的令牌(Token)。取值:
| FFmyTO70tTpLG6I3FmYAXGKPd**** |
MaxResults | integer | 否 | 分批次查询时每次显示的条目数。 取值范围:1~100,入参为空时,默认值:20。 | 50 |
ListenerProtocol | string | 否 | 传统型负载均衡监听协议。取值:
| http |
LoadBalancerId | array | 否 | 传统型负载均衡实例的 ID 列表,最多支持 10 个实例 ID。 | |
string | 否 | 传统型负载均衡实例的 ID。 | lb-uf6so8u4g35prnvsw**** | |
Tag | array<object> | 否 | 标签列表。 | |
object | 否 | 标签列表。 | ||
Key | string | 否 | 资源的标签键。N 的取值范围:1~20。一旦输入该值,则不允许为空字符串。 最多支持 64 个字符,不能以 | TestKey |
Value | string | 否 | 资源的标签值。N 的取值范围:1~20。一旦输入该值,可以为空字符串。
最多支持 128 个字符,不能以 | TestValue |
ListenerPort | integer | 否 | CLB 实例使用的监听端口。 | 443 |
Description | string | 否 | 自定义监听名称。 | HTTPS_443 |
返回参数
示例
正常返回示例
JSON
格式
{
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
"TotalCount": 10,
"MaxResults": 50,
"Listeners": [
{
"AclType": "white",
"Status": "running",
"VServerGroupId": "rsp-cige6j****",
"ListenerProtocol": "http",
"LoadBalancerId": "lb-bp1b6c719dfa****",
"ListenerPort": 80,
"AclId": "acl-a2do9e413e0spzasx****",
"Scheduler": "wrr",
"Bandwidth": -1,
"Description": "test",
"AclStatus": "off",
"BackendServerPort": 80,
"AclIds": [
""
],
"HTTPListenerConfig": {
"HealthCheckHttpVersion": "HTTP 1.0",
"XForwardedFor_ClientSrcPort": "on",
"Cookie": "B490B5EBF6F3CD402E515D22BCDA****",
"Gzip": "on",
"HealthCheckConnectPort": 8080,
"HealthCheckTimeout": 3,
"HealthCheckType": "tcp",
"CookieTimeout": 500,
"HealthCheckDomain": "www.example.com",
"UnhealthyThreshold": 4,
"XForwardedFor_SLBID": "on",
"ForwardPort": 80,
"HealthCheckHttpCode": "http_2xx,http_3xx",
"ListenerForward": "on",
"XForwardedFor": "on",
"IdleTimeout": 15,
"RequestTimeout": 60,
"HealthCheckInterval": 5,
"XForwardedFor_SLBPORT": "on",
"HealthCheckURI": "/test/index.html",
"StickySessionType": "insert",
"HealthyThreshold": 4,
"XForwardedFor_proto": "on",
"XForwardedFor_SLBIP": "on",
"StickySession": "on",
"HealthCheckMethod": "get",
"HealthCheck": "on"
},
"HTTPSListenerConfig": {
"XForwardedFor_ClientCertClientVerify": "off",
"HealthCheckHttpVersion": "HTTP 1.0",
"XForwardedFor_ClientSrcPort": "off",
"Cookie": "B490B5EBF6F3CD402E515D22BCDA****",
"Gzip": "on",
"EnableHttp2": "off",
"CACertificateId": "idkp-234-cn-test-0****",
"HealthCheckConnectPort": 8080,
"HealthCheckTimeout": 3,
"HealthCheckType": "tcp",
"CookieTimeout": 500,
"HealthCheckDomain": "www.example.com",
"UnhealthyThreshold": 4,
"XForwardedFor_SLBID": "on",
"XForwardedFor_ClientCertSubjectDN": "off",
"HealthCheckHttpCode": "http_2xx,http_3xx",
"XForwardedFor_ClientCertFingerprint": "off",
"XForwardedFor": "on",
"RequestTimeout": 60,
"IdleTimeout": 15,
"ServerCertificateId": "idkp-123-cn-test-0****",
"HealthCheckInterval": 5,
"XForwardedFor_SLBPORT": "off",
"HealthCheckURI": "/test/index.html",
"StickySessionType": "insert",
"XForwardedFor_ClientCertIssuerDN": "off",
"HealthyThreshold": 4,
"XForwardedFor_proto": "on",
"XForwardedFor_SLBIP": "on",
"StickySession": "on",
"HealthCheckMethod": "get",
"TLSCipherPolicy": "tls_cipher_policy_1_0",
"HealthCheck": "on"
},
"TCPListenerConfig": {
"HealthCheckHttpCode": "http_2xx,http_3xx",
"ConnectionDrainTimeout": 300,
"PersistenceTimeout": 0,
"HealthCheckInterval": 5,
"HealthCheckURI": "/test/index.html",
"HealthCheckConnectPort": 8080,
"EstablishedTimeout": 500,
"HealthCheckType": "tcp",
"HealthCheckConnectTimeout": 100,
"MasterSlaveServerGroupId": "rsp-0bfucw*****",
"HealthyThreshold": 4,
"HealthCheckDomain": "www.example.com",
"UnhealthyThreshold": 4,
"ConnectionDrain": "off",
"HealthCheckMethod": "get",
"HealthCheck": "on",
"ProxyProtocolV2Enabled": "false"
},
"UDPListenerConfig": {
"ConnectionDrainTimeout": 300,
"HealthCheckInterval": 5,
"HealthCheckExp": "ok",
"HealthCheckConnectPort": 8080,
"HealthCheckConnectTimeout": 100,
"MasterSlaveServerGroupId": "rsp-0bfucw****",
"HealthyThreshold": 4,
"UnhealthyThreshold": 4,
"ConnectionDrain": "off",
"HealthCheckReq": "hello",
"HealthCheck": "on",
"ProxyProtocolV2Enabled": "false"
},
"Tags": [
{
"TagValue": "TestValue",
"TagKey": "TestKey"
}
]
}
]
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | IllegalParam.ListenerProtocol | The param of ListenerProtocol is illegal. | 指定的ListenerProtocol无效。请检查参数约束,并在修改后重试。 |
400 | IllegalParam.MaxResults | The param of MaxResults is illegal. | 指定的MaxResults无效。请检查参数约束,并在修改后重试。 |
400 | IllegalParam.NextToken | The param of NextToken is illegal. | 指定的NextToken无效。请检查参数约束,并在修改后重试。 |
400 | IllegalParamSize.LoadBalancerId | The param size of LoadBalancerId is illegal. | 指定的LoadBalancerId无效。请检查参数约束,并在修改后重试。 |
400 | MissingParam.TagKey | The param of TagKey is missing. | - |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-05-28 | OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |
2023-10-25 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-07-04 | OpenAPI 错误码发生变更 | 查看变更详情 |