DescribeLoadBalancerHTTPSListenerAttribute-阿里云帮助中心

Queries the configuration of an HTTPS listener.

Operation description

You have created a Classic Load Balancer (CLB) instance. For more information, see CreateLoadBalancer.
You have created an HTTPS listener. For more information, see CreateLoadBalancerHTTPSListener.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

slb:DescribeLoadBalancerHTTPSListenerAttribute

get

*loadbalancer

acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}

slb:tag
slb:tag
slb:tag

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID of the Classic Load Balancer (CLB) instance.	cn-hangzhou
LoadBalancerId	string	Yes	The ID of the Classic Load Balancer (CLB) instance.	lb-bp1mxu5r8lau****
ListenerPort	integer	Yes	The frontend port used by the instance. Valid values: 1 to 65535.	80

Response elements

Element	Type	Description	Example
	object
AclType	string	The type of access control. Valid values: white: Only requests from the IP addresses or CIDR blocks in the selected access control policy group are forwarded. Whitelists are applicable to scenarios in which you want to allow only specific IP addresses to access your service. Enabling a whitelist poses some risks to your services. After a whitelist is enabled, only the IP addresses in the whitelist can access the SLB listener. If a whitelist is enabled but no IP address is added to the access control policy group, the SLB listener forwards all requests. black: All requests from the IP addresses or CIDR blocks in the selected access control policy group are blocked. Blacklists are applicable to scenarios in which you want to deny access from specific IP addresses. If a blacklist is enabled but no IP address is added to the access control policy group, the SLB listener forwards all requests. Note This parameter is required when the value of AclStatus is on.	white
XForwardedFor_ClientCertClientVerify	string	Indicates whether the `XForwardedFor_ClientCertClientVerify` header is used to retrieve the verification result of the client certificate that accesses the SLB instance. Valid values: on: Yes. off: No.	off
CACertificateId	string	The CA certificate ID.	idkp-234-cn-test-0**
RequestId	string	The request ID.	365F4154-92F6-4AE4-92F8-7FF3********
HealthCheckConnectPort	integer	The port used for health checks. Note This parameter takes effect only when HealthCheck is set to on.	8080
BackendServerPort	integer	The backend port used by the instance.	8080
CookieTimeout	integer	The cookie timeout period.	500
HealthCheckDomain	string	The domain name used for health checks.	www.test.com
XForwardedFor	string	Indicates whether the `X-Forwarded-For` header is used to retrieve the originating IP address of the client. Valid values: on: Yes. off: No.	on
XForwardedFor_ClientCertFingerprint	string	Indicates whether the `XForwardedFor_ClientCertFingerprint` header is used to retrieve the fingerprint of the client certificate that accesses the SLB instance. Valid values: on: Yes. off: No.	off
IdleTimeout	integer	The idle connection timeout period. Valid values: 1 to 60. Default value: 15. Unit: seconds. If no access request is received within the specified timeout period, Server Load Balancer temporarily breaks the current connection and waits until the next request arrives to establish a new connection.	23
ListenerPort	integer	The frontend port used by the instance.	80
HealthCheckURI	string	The URI used for health checks.	/test/index.html
XForwardedFor_SLBPORT	string	Indicates whether the `XForwardedFor_SLBPORT` header is used to retrieve the listener port of the SLB instance. Valid values: on: Yes. off: No.	off
StickySessionType	string	The method used to handle cookies. Valid values: insert and server. insert: Insert cookie. When a client sends a request for the first time, Server Load Balancer inserts a cookie into the response. The next time the client sends a request with this cookie, the Server Load Balancer service forwards the request to the backend server that was previously recorded. server: Rewrite cookie. When Server Load Balancer detects a user-defined cookie, it rewrites the original cookie. The next time the client sends a request with the new cookie, the Server Load Balancer service forwards the request to the backend server that was previously recorded.	insert
Scheduler	string	The scheduling algorithm. Valid values: wrr and rr. wrr: Backend servers with higher weights receive more requests. rr: Requests are distributed to backend servers in sequence.	wrr
XForwardedFor_proto	string	Indicates whether the `X-Forwarded-Proto` header is used to retrieve the listener protocol of the SLB instance. Valid values: on: Yes. off: No.	on
HealthCheckMethod	string	The health check method used for HTTP-type health checks on the listener. Valid values: head and get. Note This parameter is returned only when HealthCheck is set to on.	get
TLSCipherPolicy	string	The TLSCipherPolicy parameter can be specified only for guaranteed-performance instances. Each policy defines a security policy. A security policy contains the TLS protocol versions and encryption algorithm suites available for HTTPS. tls_cipher_policy_1_0: Supported TLS versions: TLSv1.0, TLSv1.1, and TLSv1.2. Supported encryption algorithm suites: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, AES128-GCM-SHA256, AES256-GCM-SHA384, AES128-SHA256, AES256-SHA256, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA, AES128-SHA, AES256-SHA, and DES-CBC3-SHA. tls_cipher_policy_1_1: Supported TLS versions: TLSv1.1 and TLSv1.2. Supported encryption algorithm suites: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, AES128-GCM-SHA256, AES256-GCM-SHA384, AES128-SHA256, AES256-SHA256, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA, AES128-SHA, AES256-SHA, and DES-CBC3-SHA. tls_cipher_policy_1_2 Supported TLS versions: TLSv1.2. Supported encryption algorithm suites: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, AES128-GCM-SHA256, AES256-GCM-SHA384, AES128-SHA256, AES256-SHA256, ECDHE-RSA-AES128-SHA, ECDHE-RSA-AES256-SHA, AES128-SHA, AES256-SHA, and DES-CBC3-SHA. tls_cipher_policy_1_2_strict Supported TLS versions: TLSv1.2. Supported encryption algorithm suites: ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, ECDHE-RSA-AES128-SHA, and ECDHE-RSA-AES256-SHA. tls_cipher_policy_1_2_strict_with_1_3 Supported TLS versions: TLSv1.2 and TLSv1.3. Supported encryption algorithm suites: TLS_AES_128_GCM_SHA256, TLS_AES_256_GCM_SHA384, TLS_CHACHA20_POLY1305_SHA256, TLS_AES_128_CCM_SHA256, TLS_AES_128_CCM_8_SHA256, ECDHE-ECDSA-AES128-GCM-SHA256, ECDHE-ECDSA-AES256-GCM-SHA384, ECDHE-ECDSA-AES128-SHA256, ECDHE-ECDSA-AES256-SHA384, ECDHE-RSA-AES128-GCM-SHA256, ECDHE-RSA-AES256-GCM-SHA384, ECDHE-RSA-AES128-SHA256, ECDHE-RSA-AES256-SHA384, ECDHE-ECDSA-AES128-SHA, ECDHE-ECDSA-AES256-SHA, ECDHE-RSA-AES128-SHA, and ECDHE-RSA-AES256-SHA.	tls_cipher_policy_1_0
Status	string	The status of the listener. Valid values: running: Running. stopped: Stopped.	stopped
VServerGroupId	string	The ID of the associated vServer group.	rsp-cige6j5e********
XForwardedFor_ClientSrcPort	string	Indicates whether the `XForwardedFor_ClientSrcPort` header is used to retrieve the port of the client that accesses the SLB instance. Valid values: on: Yes. off: No.	off
Cookie	string	The cookie configured on the server.	testCookie
Gzip	string	Indicates whether `Gzip` compression is enabled. Valid values: on: Yes. off: No.	on
EnableHttp2	string	Indicates whether `HTTP/2` is enabled. Valid values: on: Yes. off: No.	off
Bandwidth	integer	The peak bandwidth of the listener. Unit: Mbit/s.	10
Description	string	The custom listener name.	HTTPS_443
HealthCheckTimeout	integer	The maximum timeout period for each health check response. Unit: seconds.	3
AclStatus	string	Indicates whether access control is enabled. Valid values: on: Yes. off: No.	off
UnhealthyThreshold	integer	The unhealthy health check threshold.	4
XForwardedFor_SLBID	string	Indicates whether the `SLB-ID` header is used to retrieve the instance ID of the SLB instance. Valid values: on: Yes. off: No.	on
XForwardedFor_ClientCertSubjectDN	string	Indicates whether the `XForwardedFor_ClientCertSubjectDN` header is used to retrieve the owner information of the client certificate that accesses the SLB instance. Valid values: on: Yes. off: No.	off
SecurityStatus	string	Indicates whether the listener is in a secure state. Valid values: on: Yes. off: No.	on
HealthCheckHttpCode	string	The HTTP status code that indicates a healthy health check.	http_2xx,http_3xx
RequestTimeout	integer	The request timeout period. Valid values: 1 to 180. Default value: 60. Unit: seconds. If no response is received from the backend server within the specified timeout period, Server Load Balancer stops waiting and returns an HTTP 504 error code to the client.	43
HealthCheckInterval	integer	The interval between two consecutive health checks. Unit: seconds.	5
ServerCertificateId	string	The ID of the server certificate.	idkp-123-cn-test-0**
AclId	string	The ID of the access control policy group associated with the listener. Note This parameter is required when the value of AclStatus is on.	acl-a2do9e413e0spzasx****
XForwardedFor_ClientCertIssuerDN	string	Indicates whether the `XForwardedFor_ClientCertIssuerDN` header is used to retrieve the issuer information of the client certificate that accesses the SLB instance. Valid values: on: Yes. off: No.	off
HealthyThreshold	integer	The healthy health check threshold.	4
XForwardedFor_SLBIP	string	Indicates whether the `SLB-IP` header is used to retrieve the virtual IP address (VIP) of the client request. Valid values: on: Yes. off: No.	on
StickySession	string	Indicates whether session persistence is enabled. Valid values: on: Enabled. off: Disabled.	on
HealthCheck	string	Indicates whether health check is enabled. Valid values: on: Yes. off: No.	on
AclIds	object
AclId	array	The ID of the access control policy group associated with the listener.

Rules	object
Rule	array<object>	The list of forwarding rules configured for the listener.
	object	The list of forwarding rules configured for the listener.
VServerGroupId	string	The ID of the destination vServer group of the forwarding rule.	rsp-cige6j5e********
Url	string	The access path.	/example
Domain	string	The domain name.	www.example.com
RuleName	string	The name of the forwarding rule.	example
RuleId	string	The ID of the forwarding rule.	23
DomainExtensions	object
DomainExtension	array<object>	The list of additional domain names.
	object	The list of additional domain names.
ServerCertificateId	string	The ID of the certificate associated with the domain name.	13344444****
Domain	string	The domain name.	www.example.com
DomainExtensionId	string	The ID of the additional domain name.	12
LoadBalancerId	string	The Classic Load Balancer (CLB) instance ID.	lb-bp1mxu5r8lau****
Tags	object
Tag	array<object>	The list of tags.
	object	The list of tags.
TagKey	string	The tag key of the listener. Valid values of N: 1 to 20. The tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	TestKey
TagValue	string	The tag value of the listener. Valid values of N: 1 to 20. The tag value can be an empty string. The tag value can be up to 128 characters in length and cannot start with `acs:`. It cannot contain `http://` or `https://`.	TestValue

Examples

Success response

JSON format

{
  "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": "testCookie",
  "Gzip": "on",
  "EnableHttp2": "off",
  "Bandwidth": 10,
  "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": "acl-a2do9e413e0spzasx****",
  "XForwardedFor_ClientCertIssuerDN": "off",
  "HealthyThreshold": 4,
  "XForwardedFor_SLBIP": "on",
  "StickySession": "on",
  "HealthCheck": "on",
  "AclIds": {
    "AclId": [
      ""
    ]
  },
  "Rules": {
    "Rule": [
      {
        "VServerGroupId": "rsp-cige6j5e********",
        "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"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.