String
Specifies the body of the certificate required by HTTPS listeners. The value must be PEM encoded.
-Maximum 65,536 character length is allowed, supports certificate chains with a maximum of 11 layers (including certificates and certificate chains).
+Specifies the body of the certificate required by HTTPS listeners.
+The value must be PEM encoded, and can contain a maximum of 65,536 characters.
+It supports certificate chains with a maximum of 11 layers (including certificates and certificate chains).
description
@@ -126,7 +127,7 @@Note the following when using domain names:
The value can contain 0 to 10,000 characters and consists of multiple common domain names or wildcard domain names separated by commas. A maximum of 100 domain names are allowed.
A common domain name consists of several labels separated by periods (.). Each label can contain a maximum of 63 characters, including letters, digits, and hyphens (-), and must start and end with a letter or digit. Example: www.test.com
-A wildcard domain name is a domain name starts with an asterisk (*). Example: *.test.com
+A wildcard domain name is a domain name starting with an asterisk (*). Example: *.test.com
This parameter will take effect only when type is set to server.
SNI certificates of a dedicated load balancer's listener can have up to 200 domain names.
SNI certificates of a shared load balancer's listener can have up to 30 domain names.
@@ -263,7 +264,7 @@Note the following when using domain names:
The value can contain 0 to 10,000 characters and consists of multiple common domain names or wildcard domain names separated by commas. A maximum of 100 domain names are allowed.
A common domain name consists of several labels separated by periods (.). Each label can contain a maximum of 63 characters, including letters, digits, and hyphens (-), and must start and end with a letter or digit. Example: www.test.com
-A wildcard domain name is a domain name starts with an asterisk (*). Example: *.test.com
+A wildcard domain name is a domain name starting with an asterisk (*). Example: *.test.com
This parameter will take effect only when type is set to server.
SNI certificates of a dedicated load balancer's listener can have up to 200 domain names.
SNI certificates of a shared load balancer's listener can have up to 30 domain names.
@@ -338,7 +339,7 @@Creating a server certificate
-POST https://{elb_endponit}/v3/{project_id}/elb/certificates
+POST https://{ELB_Endpoint}/v3/{project_id}/elb/certificates
{
"certificate" : {
diff --git a/docs/elb/api-ref/CreateHealthMonitor.html b/docs/elb/api-ref/CreateHealthMonitor.html
index 252ca376d..5298e2c75 100644
--- a/docs/elb/api-ref/CreateHealthMonitor.html
+++ b/docs/elb/api-ref/CreateHealthMonitor.html
@@ -118,7 +118,7 @@
Specifies the domain name that HTTP requests are sent to during the health check.
The value can contain only digits, letters, hyphens (-), and periods (.) and must start with a digit or letter.
The value is left blank by default, indicating that the virtual IP address of the load balancer is used as the destination address of HTTP requests.
-This parameter is available only when type is set to HTTP.
+This parameter is available only when type is set to HTTP or HTTPS.
Minimum: 1
Maximum: 100
String
Specifies the HTTP request path for the health check. The value must start with a slash (/), and the default value is /.
-Note: This parameter is available only when type is set to HTTP.
+Note: This parameter is available when type is set to HTTP or HTTPS.
Default: /
Minimum: 1
Maximum: 80
http_version
+No
+String
+Specifies the HTTP version used for health checks.
+The value can be HTTP/1.0 or HTTP/1.1. By default, this parameter is left blank, indicating that no HTTP version is specified.
+Note: This parameter is available only when type is set to HTTP or HTTPS.
+This parameter is unsupported. Please do not use it.
+content_check_enable
+No
+Boolean
+Specifies whether to enable health check content verification.
+The value can be:
+true: Health check content verification will be enabled.
+false (default): Health check content verification will be disabled.
+Note: This parameter can be enabled only when type is set to TCP or UDP_CONNECT.
+This parameter is unsupported. Please do not use it.
+send_content
+No
+String
+Specifies the health check content to be sent. ELB sends the configured content and waits for a response from the backend server. If the backend server returns a content that is the same as that defined by receive_content, the backend server is considered healthy.
+The value can contain:
+1 to 64 characters if content_format is set to TEXT. It supports letters, digits, and the following special characters: !"#$%&'()*+,/:;<=>?@[]^-_`{|}~.
+2 to 64 characters if content_format is set to HEX. The value must have an even number of characters and can contain only hexadecimal characters (0–9 and A–F).
+Note: This parameter only works when type is set to TCP or UDP_CONNECT and content_check_enable is set to true.
+This parameter is unsupported. Please do not use it.
+receive_content
+No
+String
+Specifies the health check response content you expect from the backend server. If the backend server returns a content that is the same as that defined by receive_content, the backend server is considered healthy.
+The value can contain:
+1 to 64 characters if content_format is set to TEXT. It supports letters, digits, and the following special characters: !"#$%&'()*+,/:;<=>?@[]^-_`{|}~.
+2 to 64 characters if content_format is set to HEX. The value must have an even number of characters and can contain only hexadecimal characters (0–9 and A–F).
+Note: This parameter only works when type is set to TCP or UDP_CONNECT and content_check_enable is set to true.
+This parameter is unsupported. Please do not use it.
+content_format
+No
+String
+Specifies the health check content format.
+The value can be:
+TEXT: The content can contain only letters, digits, and the following special characters: !"#$%&'()*+,/:;<=>?@[]^-_`{|}~.
+HEX: The content can contain only hexadecimal characters (0–9 and A–F).
+This parameter is unsupported. Please do not use it.
+Specifies the domain name that HTTP requests are sent to during the health check.
The value can contain only digits, letters, hyphens (-), and periods (.) and must start with a digit or letter.
The value is left blank by default, indicating that the virtual IP address of the load balancer is used as the destination address of HTTP requests.
-This parameter is available only when type is set to HTTP.
+This parameter is available when type is set to HTTP or HTTPS.
expected_codes
@@ -459,6 +530,67 @@This is a new field in this version, and it will not be returned for resources associated with existing dedicated load balancers and for resources associated with existing and new shared load balancers.
http_version
+String
+Specifies the HTTP version used for health checks.
+The value can be HTTP/1.0 or HTTP/1.1. By default, this parameter is left blank, indicating that no HTTP version is specified.
+Note: This parameter is available only when type is set to HTTP or HTTPS.
+This parameter is unsupported. Please do not use it.
+content_check_enable
+Boolean
+Specifies whether to enable health check content verification.
+The value can be:
+true: Health check content verification will be enabled.
+false (default): Health check content verification will be disabled.
+Note: This parameter can be enabled only when type is set to TCP or UDP_CONNECT.
+This parameter is unsupported. Please do not use it.
+send_content
+String
+Specifies the health check content to be sent. ELB sends the configured content and waits for a response from the backend server. If the backend server returns a content that is the same as that defined by receive_content, the backend server is considered healthy.
+The value can contain:
+1 to 64 characters if content_format is set to TEXT. It supports letters, digits, and the following special characters: "!#$%&'()*+,/:;<=>?@[]^-_`{|}~.
+2 to 64 characters if content_format is set to HEX. The value must have an even number of characters and can contain only hexadecimal characters (0–9 and A–F).
+Note: This parameter only works when type is set to TCP or UDP_CONNECT and content_check_enable is set to true.
+This parameter is unsupported. Please do not use it.
+receive_content
+String
+Specifies the health check response content you expect from the backend server. If the backend server returns a content that is the same as that defined by receive_content, the backend server is considered healthy.
+The value can contain:
+1 to 64 characters if content_format is set to TEXT. It supports letters, digits, and the following special characters: "!#$%&'()*+,/:;<=>?@[]^-_`{|}~.
+2 to 64 characters if content_format is set to HEX. The value must have an even number of characters and can contain only hexadecimal characters (0–9 and A–F).
+Note: This parameter only works when type is set to TCP or UDP_CONNECT and content_check_enable is set to true.
+This parameter is unsupported. Please do not use it.
+content_format
+String
+Specifies the health check content format.
+The value can be:
+TEXT: The content can contain only letters, digits, and the following special characters: "!#$%&'()*+,/:;<=>?@[]^-_`{|}~.
+HEX: The content can contain only hexadecimal characters (0–9 and A–F).
+This parameter is unsupported. Please do not use it.
+String
Specifies the ID of the enterprise project that the IP address group belongs to.
+This parameter is unsupported. Please do not use it.
This API is used to add a forwarding policy to a listener.
Forwarding policies can be added to only to HTTP or HTTPS listeners.
+Forwarding policies can be added only to HTTP or HTTPS listeners.
POST /v3/{project_id}/elb/l7policies
@@ -99,9 +99,9 @@REDIRECT_TO_URL: Requests will be redirected to another URL.
FIXED_RESPONSE: A fixed response body will be returned.
REDIRECT_TO_LISTENER has the highest priority. If requests are to be redirected to an HTTPS listener, other forwarding policies of the listener will become invalid.
Note:
-If action is set to REDIRECT_TO_POOL, the listener's protocol must be HTTP or HTTPS.
+REDIRECT_TO_LISTENER has the highest priority. If requests are to be redirected to an HTTPS listener, other forwarding policies of the listener will become invalid.
+If action is set to REDIRECT_TO_POOL, the listener's protocol must be HTTP or HTTPS.
If action is set to REDIRECT_TO_LISTENER, the listener's protocol must be HTTP.
Minimum: 1
diff --git a/docs/elb/api-ref/CreateL7Rule.html b/docs/elb/api-ref/CreateL7Rule.html index a80bf04f8..0e3fd1b09 100644 --- a/docs/elb/api-ref/CreateL7Rule.html +++ b/docs/elb/api-ref/CreateL7Rule.html @@ -3,7 +3,7 @@This API is used to add a forwarding rule.
If the action of l7policy is set to Redirect to another listener, 17rule cannot be created.
+The forwarding rule cannot be created when action is set to REDIRECT_TO_LISTENER.
POST /v3/{project_id}/elb/l7policies/{l7policy_id}/rules
diff --git a/docs/elb/api-ref/CreateListener.html b/docs/elb/api-ref/CreateListener.html index c22f6c0ed..cd781cbfe 100644 --- a/docs/elb/api-ref/CreateListener.html +++ b/docs/elb/api-ref/CreateListener.html @@ -3,8 +3,7 @@This API is used to add a listener to a load balancer.
The protocol used by the listener can be TCP, UDP, HTTP, or HTTPS.
-For load balancing at Layer 4, the protocol can only be TCP or UDP.
+For load balancing at Layer 4, the protocol can only be TCP or UDP.
For load balancing at Layer 7, the protocol can only be HTTP or HTTPS.
For load balancing both at Layer 4 and Layer 7, TCP, UDP, HTTP, and HTTPS are supported.
String
Specifies the listener name.
+Note: If you leave the listener name empty, you cannot locate it on the listener list and view its details.
Minimum: 0
Maximum: 255
Integer
Specifies the protocol used by the listener.
+Specifies the port used by the listener to receive requests from clients.
Minimum: 1
Maximum: 65535
CreateListenerIpGroupOption object
Specifies the IP address group associated with the listener.
+Specifies the IP address group associated with the listener. The value can be null or an empty JSON structure, indicating that no IP address group is associated with the listener. ipgroup_id is also required if you want to associate an IP address group with the listener.
transparent_client_ip_enable
@@ -382,7 +382,7 @@Specifies whether to enable advanced forwarding. If advanced forwarding is enabled, more flexible forwarding policies and rules are supported. The value can be true (enable advanced forwarding) or false (disable advanced forwarding), and the default value is false.
The following scenarios are supported:
-action can be set to REDIRECT_TO_URL (requests will be redirected to another URL) or Fixed_RESPONSE (a fixed response body will be returned to clients).
+action can be set to REDIRECT_TO_URL (requests will be redirected to another URL) or FIXED_RESPONSE (a fixed response body will be returned to clients).
Parameters priority, redirect_url_config, and fixed_response_config can be specified in a forwarding policy.
Parameter type can be set to METHOD, HEADER, QUERY_STRING, or SOURCE_IP for a forwarding rule.
If type is set to HOST_NAME for a forwarding rule, the value parameter of the forwarding rule supports wildcard asterisks (*).
@@ -416,6 +416,22 @@Maximum: 255
access_log_customized_headers_config
+No
+Definition:
+Specifies the custom headers to be recorded in access logs. You can specify which headers to be or not to be recorded in the access logs of a load balancer.
+Constraints:
+This parameter is available only for HTTP, HTTPS, and QUIC listeners.
+Range:
+N/A
+Default value:
+N/A
+Boolean
Specifies whether to transparently transmit the load balancer EIP to backend servers. If X-Forwarded-ELB-IP is set to true, the load balancer EIP will be stored in the HTTP header and passed to backend servers.
-Default: false
+Definition: If X-Forwarded-ELB-IP is set to true, the load balancer EIP will be stored in the HTTP header and passed to backend servers.
X-Forwarded-Port
@@ -446,8 +461,7 @@Boolean
Specifies whether to transparently transmit the listening port of the load balancer to backend servers. If X-Forwarded-Port is set to true, the listening port of the load balancer will be stored in the HTTP header and passed to backend servers.
-Default: false
+Definition: If X-Forwarded-Port is set to true, the listening port of the load balancer will be stored in the HTTP header and passed to backend servers.
X-Forwarded-For-Port
@@ -456,8 +470,7 @@Boolean
Specifies whether to transparently transmit the source port of the client to backend servers. If X-Forwarded-For-Port is set to true, the source port of the client will be stored in the HTTP header and passed to backend servers.
-Default: false
+Definition: If X-Forwarded-For-Port is set to true, the source port of the client will be stored in the HTTP header and passed to backend servers.
X-Forwarded-Host
@@ -466,8 +479,389 @@Boolean
Specifies whether to rewrite the X-Forwarded-Host header. If X-Forwarded-Host is set to true, X-Forwarded-Host in the request header from the clients can be set to Host in the request header sent from the load balancer to backend servers.
-Default: true
+Definition: If X-Forwarded-Host is set to true, X-Forwarded-Host in the request header from the clients can be set to Host in the request header sent from the load balancer to backend servers.
+X-Forwarded-Proto
+No
+Boolean
+Definition: If X-Forwarded-Proto is set to true, the listener protocol of the load balancer can be stored in the X-Forwarded-Proto header and passed to backend servers.
+X-Real-IP
+No
+Boolean
+Definition: If X-Real-IP is set to true, the client IP address can be stored in the X-Real-IP header and passed to backend servers.
+X-Forwarded-ELB-ID
+No
+Boolean
+Definition: If X-Forwarded-ELB-ID is set to true, the load balancer ID can be stored in the X-Forwarded-ELB-ID header and passed to backend servers.
+X-Forwarded-TLS-Certificate-ID
+No
+Boolean
+Definition: If X-Forwarded-TLS-Certificate-ID is set to true, the certificate ID of the load balancer can be stored in the X-Forwarded-TLS-Certificate-ID header and passed to backend servers.
+X-Forwarded-TLS-Protocol
+No
+Boolean
+Definition: If X-Forwarded-TLS-Protocol is set to true, the algorithm protocol of the load balancer can be stored in the X-Forwarded-TLS-Protocol header and passed to backend servers.
+X-Forwarded-TLS-Cipher
+No
+Boolean
+Definition: If X-Forwarded-TLS-Cipher is set to true, the algorithm suite of the load balancer can be stored in the X-Forwarded-TLS-Cipher header and passed to backend servers.
+X-Forwarded-TLS-Protocol-alias
+No
+String
+Definition: Specifies the name of the X-Forwarded-TLS-Protocol header.
+Constraints: This parameter takes effect only if X-Forwarded-TLS-Protocol is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.
+Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.
+Default value: N/A
+X-Forwarded-TLS-Cipher-alias
+No
+String
+Definition: Specifies the name of the X-Forwarded-TLS-Cipher header.
+Constraints: This parameter takes effect only if X-Forwarded-TLS-Cipher is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.
+Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.
+Default value: N/A
+X-Forwarded-For-Processing-Mode
+No
+String
+Definition: Specifies how the X-Forwarded-For header will be handled.
+append: The IP address of the last hop will be included in the X-Forwarded-For header and sent to the backend server.
+remove: The X-Forwarded-For header will be deleted before the request is sent to the backend server, regardless of whether the request carries the X-Forwarded-For header.
+preserve: The existing X-Forwarded-For header will be retained in the request.
+Constraints: This parameter is available only for HTTP, HTTPS, TERMINATED_HTTPS, and QUIC listeners.
+Range: append, remove, or preserve
+Default value: append
+X-Forwarded-Clientcert-subjectdn-enable
+No
+Boolean
+Definition: Specifies whether to transfer the owner information of the client certificate that accesses the load balancer through the X-Forwarded-Clientcert-subjectdn header.
+Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.
+Range: true or false
+Default value: false
+X-Forwarded-Clientcert-subjectdn-alias
+No
+String
+Definition: Specifies the name of the X-Forwarded-Clientcert-subjectdn header.
+Constraints: This parameter takes effect only if X-Forwarded-Clientcert-subjectdn-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.
+Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.
+Default value: N/A
+X-Forwarded-Clientcert-issuerdn-enable
+No
+Boolean
+Definition: Specifies whether to transfer the issuer information of the client certificate that accesses the load balancer through the X-Forwarded-Clientcert-issuerdn header.
+Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.
+Range: true or false
+Default value: false
+X-Forwarded-Clientcert-issuerdn-alias
+No
+String
+Definition: Specifies the name of the X-Forwarded-Clientcert-issuerdn header.
+Constraints: This parameter takes effect only if X-Forwarded-Clientcert-issuerdn-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.
+Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.
+Default value: N/A
+X-Forwarded-Clientcert-fingerprint-enable
+No
+Boolean
+Definition: Specifies whether to transfer the fingerprint of the client certificate that accesses the load balancer through the X-Forwarded-Clientcert-fingerprint header.
+Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.
+Range: true or false
+Default value: false
+X-Forwarded-Clientcert-fingerprint-alias
+No
+String
+Definition: Specifies the name of the X-Forwarded-Clientcert-fingerprint header.
+Constraints: This parameter takes effect only if X-Forwarded-Clientcert-fingerprint-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.
+Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.
+Default value: N/A
+X-Forwarded-Clientcert-clientverify-enable
+No
+Boolean
+Definition: Specifies whether to transfer the verification result of the client certificate that accesses the load balancer through the X-Forwarded-Clientcert-clientverify header.
+Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.
+Range: true or false
+Default value: false
+X-Forwarded-Clientcert-clientverify-alias
+No
+String
+Definition: Specifies the name of the X-Forwarded-Clientcert-clientverify header.
+Constraints: This parameter takes effect only if X-Forwarded-Clientcert-clientverify-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.
+Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.
+Default value: N/A
+X-Forwarded-Clientcert-serialnumber-enable
+No
+Boolean
+Definition: Specifies whether to transfer the client certificate serial number through the X-Forwarded-Clientcert-serialnumber header.
+Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.
+Range: true or false
+Default value: false
+X-Forwarded-Clientcert-serialnumber-alias
+No
+String
+Definition: Specifies the name of the X-Forwarded-Clientcert-serialnumber header.
+Constraints: This parameter takes effect only if X-Forwarded-Clientcert-serialnumber-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.
+Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.
+Default value: N/A
+X-Forwarded-Clientcert-enable
+No
+Boolean
+Definition: Specifies whether to transfer the client certificate content through the X-Forwarded-Clientcert header.
+Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.
+Range: true or false
+Default value: false
+X-Forwarded-Clientcert-alias
+No
+String
+Definition: Specifies the name of the X-Forwarded-Clientcert header.
+Constraints: This parameter takes effect only if X-Forwarded-Clientcert-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, QUIC, and TLS listeners.
+Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.
+Default value: N/A
+X-Forwarded-Clientcert-ciphers-enable
+No
+Boolean
+Definition: Specifies whether to transfer the TLS cipher suite supported by the client through the X-Forwarded-Clientcert-ciphers header.
+Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.
+Range: true or false
+Default value: false
+X-Forwarded-Clientcert-ciphers-alias
+No
+String
+Definition: Specifies the name of the X-Forwarded-Clientcert-ciphers header.
+Constraints: This parameter takes effect only if X-Forwarded-Clientcert-ciphers-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.
+Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.
+Default value: N/A
+X-Forwarded-Clientcert-end-enable
+No
+Boolean
+Definition: Specifies whether to transfer the client certificate expiration date through the X-Forwarded-Clientcert-end header.
+Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.
+Range: true or false
+Default value: false
+X-Forwarded-Clientcert-end-alias
+No
+String
+Definition: Specifies the name of the X-Forwarded-Clientcert-end header.
+Constraints: This parameter takes effect only if X-Forwarded-Clientcert-end-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, QUIC, and TLS listeners.
+Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.
+Default value: N/A
+X-Forwarded-Tls-Alpn-Protocol-enable
+No
+Boolean
+Definition: Specifies whether to use the X-Forwarded-Tls-Alpn-Protocol header to transfer the application protocol that the client and the load balancer negotiate to use during SSL handshakes.
+Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.
+Range: true or false
+Default value: false
+X-Forwarded-Tls-Alpn-Protocol-alias
+No
+String
+Definition: Specifies the name of the X-Forwarded-Tls-Alpn-Protocol header.
+Constraints: This parameter takes effect only if X-Forwarded-Tls-Alpn-Protocol-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.
+Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.
+Default value: N/A
+X-Forwarded-Tls-Sni-enable
+No
+Boolean
+Definition: Specifies whether to transfer the domain name of the SNI certificate accessed by the client through the X-Forwarded-Tls-Sni header.
+Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.
+Range: true or false
+Default value: false
+X-Forwarded-Tls-Sni-alias
+No
+String
+Definition: Specifies the name of the X-Forwarded-Tls-Sni header.
+Constraints: This parameter takes effect only if X-Forwarded-Tls-Sni-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.
+Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.
+Default value: N/A
+X-Forwarded-Tls-Ja3-enable
+No
+Boolean
+Definition: Specifies whether to transfer the Ja3 fingerprint of the client that accesses the load balancer through the X-Forwarded-Tls-Ja3 header.
+Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.
+Range: true or false
+Default value: false
+X-Forwarded-Tls-Ja3-alias
+No
+String
+Definition: Specifies the name of the X-Forwarded-Tls-Ja3 header.
+Constraints: This parameter takes effect only if X-Forwarded-Tls-Ja3-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.
+Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.
+Default value: N/A
+X-Forwarded-Tls-Ja4-enable
+No
+Boolean
+Definition: Specifies whether to transfer the Ja4 fingerprint of the client that accesses the load balancer through the X-Forwarded-Tls-Ja4 header.
+Constraints: This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.
+Range: true or false
+Default value: false
+X-Forwarded-Tls-Ja4-alias
+No
+String
+Definition: Specifies the name of the X-Forwarded-Tls-Ja4 header.
+Constraints: This parameter takes effect only if X-Forwarded-Tls-Ja4-enable is set to true. This parameter is available only for HTTPS, TERMINATED_HTTPS, and QUIC listeners.
+Range: 1 to 40 characters. Only letters, hyphens (-), underscores (_), and digits are allowed.
+Default value: N/A
Parameter + |
+Mandatory + |
+Type + |
+Description + |
+
|---|---|---|---|
enable + |
+No + |
+Boolean + |
+Definition: Specifies whether to record custom headers in access logs. +Constraints: +This parameter can be set to true only when the access logging function is enabled for the load balancer that the listener is added to. +If this parameter is set to true and the access logging function of the load balancer is disabled later, this parameter will not be automatically changed to false. If the access logging function of the load balancer is enabled again, the custom headers are still recorded. +Range: +
Default value: +false + |
+
include_headers + |
+No + |
+Array of strings + |
+Definition: Specifies the custom headers that will be recorded in access logs. If this parameter is specified, only the specified headers will be recorded in access logs. +Constraints: +A maximum of five custom headers can be configured. +Range: +Each header supports only letters, digits, underscores (_), and hyphens (-). +Each header can contain 1 to 40 characters. +The following custom headers (case-insensitive) cannot be configured: host, user-agent, referer, x-forwarded-for, x-clienttraceid, and traceparent. +Default value: +N/A + |
+
exclude_headers + |
+No + |
+Array of strings + |
+Definition: Specifies the headers that will not be recorded in access logs. If this parameter is specified, the specified headers will not be recorded in access logs. +Constraints: +A maximum of five custom headers can be configured. +Range: +Each header supports only letters, digits, underscores (_), and hyphens (-). +Each header can contain 1 to 40 characters. +The following custom headers (case-insensitive) cannot be configured: host, user-agent, referer, x-forwarded-for, x-clienttraceid, and traceparent. +Default value: +N/A + |
+
Status code: 201
-Parameter +
Response ParametersStatus code: 200 -
|
|---|