查询HTTPS监听配置。
接口说明
- 您已经创建传统型负载均衡,具体操作,请参见CreateLoadBalancer。
- 您已经创建HTTPS监听,具体操作,请参见CreateLoadBalancerHTTPSListener。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI
Explorer可以自动生成SDK代码示例。
调试调试
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
slb:DescribeLoadBalancerHTTPSListenerAttribute | READ |
|
|
无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 否 |
传统型负载均衡实例的地域ID。 |
cn-hangzhou |
LoadBalancerId | string | 是 |
传统型负载均衡实例的ID。 |
lb-bp1mxu5r8lau**** |
ListenerPort | integer | 是 |
实例前端使用的端口。 取值:1~65535。 |
80 |
返回参数
名称 | 类型 | 描述 | 示例值 |
---|---|---|---|
object | |||
AclType | string |
访问控制类型:
如果开启了白名单访问,但访问策略组中没有添加任何IP,则负载均衡监听会转发全部请求。
如果开启了黑名单访问,但访问策略组中没有添加任何IP,则负载均衡监听会转发全部请求。 说明 | white |
XForwardedFor_ClientCertClientVerify | string | 是否通过
|
off |
CACertificateId | string |
CA证书ID。 |
idkp-234-cn-test-0** |
RequestId | string |
请求ID。 |
365F4154-92F6-4AE4-92F8-7FF3******** |
HealthCheckConnectPort | integer |
健康检查的端口。 说明 | 8080 |
BackendServerPort | integer | 实例后端使用的端口。 |
8080 |
CookieTimeout | integer |
Cookie超时时间。 |
500 |
HealthCheckDomain | string |
用于健康检查的域名。 |
www.test.com |
XForwardedFor | string |
是否通过
|
on |
XForwardedFor_ClientCertFingerprint | string |
是否通过
|
off |
IdleTimeout | integer |
指定连接空闲超时时间,取值范围为1~60,默认值为15。单位:秒。 在超时时间内一直没有访问请求,负载均衡会暂时中断当前连接,直到一下次请求来临时重新建立新的连接。 |
23 |
ListenerPort | integer |
实例前端使用的端口。 |
80 |
HealthCheckURI | string |
用于健康检查的URI。 |
/test/index.html |
XForwardedFor_SLBPORT | string |
是否通过
|
off |
StickySessionType | string |
Cookie的处理方式。 取值:insert或server。
|
insert |
Scheduler | string |
调度算法。取值:wrr或rr。
|
wrr |
XForwardedFor_proto | string |
是否通过
|
on |
HealthCheckMethod | string |
监听HTTP类型健康检查的健康检查方法。取值:head或get。 说明 | get |
TLSCipherPolicy | string | 只有性能保障型实例才可以指定TLSCipherPolicy参数,每种policy定义了一种安全策略。 安全策略包含HTTPS可选的TLS协议版本和配套的加密算法套件。
|
tls_cipher_policy_1_0 |
Status | string |
当前监听的状态。取值:
|
stopped |
VServerGroupId | string |
绑定的服务器组ID。 |
rsp-cige6j5e******** |
XForwardedFor_ClientSrcPort | string |
是否通过
|
off |
Cookie | string |
服务器上配置的Cookie。 |
B490B5EBF6F3CD402E515D22BCDA1598 |
Gzip | string |
是否开启
|
on |
EnableHttp2 | string |
是否开启
|
off |
Bandwidth | integer |
监听的带宽峰值。单位:Mbps。 |
-1 |
Description | string |
自定义监听名称。 |
HTTPS_443 |
HealthCheckTimeout | integer |
每次健康检查响应的最大超时间。单位:秒。 |
3 |
AclStatus | string |
是否开启访问控制功能。取值:
|
off |
UnhealthyThreshold | integer |
不健康检查阈值。 |
4 |
XForwardedFor_SLBID | string |
是否通过
|
on |
XForwardedFor_ClientCertSubjectDN | string |
是否通过
|
off |
SecurityStatus | string |
是否处于安全状态。取值:
|
on |
HealthCheckHttpCode | string |
健康检查正常的HTTP状态码。 |
http_2xx,http_3xx |
RequestTimeout | integer |
指定请求超时时间,取值范围为1~180,默认值为60。单位:秒。 在超时时间内后端服务器一直没有响应,负载均衡将放弃等待,给客户端返回HTTP 504错误码。 |
43 |
HealthCheckInterval | integer |
健康检查的时间间隔。单位:秒。 |
5 |
ServerCertificateId | string |
服务器证书的ID。 |
idkp-123-cn-test-0** |
AclId | string |
监听绑定的访问策略组ID。 说明 | nacl-a2do9e413e0spzasx**** |
XForwardedFor_ClientCertIssuerDN | string | 是否通过
|
off |
HealthyThreshold | integer |
健康检查阈值。 |
4 |
XForwardedFor_SLBIP | string |
是否通过
|
on |
StickySession | string |
是否开启会话保持。取值:
|
on |
HealthCheck | string |
是否开启健康检查。取值:
|
on |
Rules | object [] |
监听下的转发规则列表。 |
|
VServerGroupId | string |
转发规则的目标服务器组ID。 |
12 |
Url | string |
访问路径。 |
/example |
Domain | string |
域名。 |
www.example.com |
RuleName | string |
转发规则名称。 |
example |
RuleId | string |
转发规则ID。 |
23 |
DomainExtensions | object [] |
域名扩展列表。 |
|
ServerCertificateId | string |
与域名对应的证书ID。 |
13344444**** |
Domain | string |
域名。 |
www.example.com |
DomainExtensionId | string |
域名扩展ID。 |
12 |
LoadBalancerId | string |
传统型负载均衡实例ID。 |
lb-bp1mxu5r8lau**** |
Tags | object [] |
标签列表。 |
|
TagKey | string |
监听的标签键。N的取值范围:1~20。一旦传入该值,则不允许为空字符串。最多支持64个字符,不能以 |
TestKey |
TagValue | string |
监听的标签值。N的取值范围:1~20。一旦传入该值,可以为空字符串。最多支持128个字符,不能以 |
TestValue |
示例
正常返回示例
JSON
格式
{
"AclType": "white",
"XForwardedFor_ClientCertClientVerify": "off",
"CACertificateId": "idkp-234-cn-test-0**",
"RequestId": "365F4154-92F6-4AE4-92F8-7FF3********",
"HealthCheckConnectPort": 8080,
"BackendServerPort": 8080,
"CookieTimeout": 500,
"HealthCheckDomain": "www.test.com",
"XForwardedFor": "on",
"XForwardedFor_ClientCertFingerprint": "off",
"IdleTimeout": 23,
"ListenerPort": 80,
"HealthCheckURI": "/test/index.html",
"XForwardedFor_SLBPORT": "off",
"StickySessionType": "insert",
"Scheduler": "wrr",
"XForwardedFor_proto": "on",
"HealthCheckMethod": "get",
"TLSCipherPolicy": "tls_cipher_policy_1_0",
"Status": "stopped",
"VServerGroupId": "rsp-cige6j5e********",
"XForwardedFor_ClientSrcPort": "off",
"Cookie": "B490B5EBF6F3CD402E515D22BCDA1598",
"Gzip": "on",
"EnableHttp2": "off",
"Bandwidth": -1,
"Description": "HTTPS_443",
"HealthCheckTimeout": 3,
"AclStatus": "off",
"UnhealthyThreshold": 4,
"XForwardedFor_SLBID": "on",
"XForwardedFor_ClientCertSubjectDN": "off",
"SecurityStatus": "on",
"HealthCheckHttpCode": "http_2xx,http_3xx",
"RequestTimeout": 43,
"HealthCheckInterval": 5,
"ServerCertificateId": "idkp-123-cn-test-0**",
"AclId": "nacl-a2do9e413e0spzasx****",
"XForwardedFor_ClientCertIssuerDN": "off",
"HealthyThreshold": 4,
"XForwardedFor_SLBIP": "on",
"StickySession": "on",
"HealthCheck": "on",
"Rules": {
"Rule": [
{
"VServerGroupId": "12",
"Url": "/example",
"Domain": "www.example.com",
"RuleName": "example",
"RuleId": "23"
}
]
},
"DomainExtensions": {
"DomainExtension": [
{
"ServerCertificateId": "13344444****",
"Domain": "www.example.com",
"DomainExtensionId": "12"
}
]
},
"LoadBalancerId": "lb-bp1mxu5r8lau****",
"Tags": {
"Tag": [
{
"TagKey": "TestKey",
"TagValue": "TestValue"
}
]
}
}
错误码
访问错误中心查看更多错误码。
内容没看懂? 不太想学习?想快速解决? 有偿解决: 联系专家
阿里云企业补贴进行中: 马上申请
腾讯云限时活动1折起,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利:同意关联,立享优惠
转转请注明出处:https://www.yunxiaoer.com/170340.html