All Products
Search
Document Center

ENS:CreateLoadBalancerHTTPListener

Last Updated:Mar 12, 2024

Creates an HTTP listener.

Operation description

  • You can call this operation up to 100 times per second per account.
  • You can call this operation up to 10 times per second per user.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
LoadBalancerIdstringYes

The ID of the Edge Load Balancer (ELB) instance.

lb-5s7crik3yo3bp03gqrbp5****
ListenerPortintegerYes

The frontend port that is used by the ELB instance. Valid values: 1 to 65535.

8080
ListenerForwardstringNo

Specifies whether to enable HTTP-to-HTTPS redirection. Valid values:

  • on
  • off (default)
off
ForwardPortintegerNo

The listener port that is used to redirect HTTP requests to HTTPS.

0
DescriptionstringNo

The description of the listener. The description must be 1 to 80 characters in length.

Note The value cannot start with http:// or https://.
XForwardedForstringNo

Specifies whether to use the X-Forwarded-For header to obtain the real IP address of the client. Valid values:

  • on
  • off (default)
off
SchedulerstringNo

The routing algorithm. Valid values:

  • wrr: Backend servers with higher weights receive more requests than backend servers with lower weights. This is the default value.
  • wlc: Requests are distributed based on the weight and load of each backend server. The load refers to the number of connections on a backend server. If two backend servers have the same weight, the backend server that has fewer connections receives more requests.
  • rr: Requests are distributed to backend servers in sequence.
  • sch: consistent hashing that is based on source IP addresses. Requests from the same source IP address are distributed to the same backend server.
  • qch: consistent hashing that is based on QUIC connection IDs. Requests that contain the same QUIC connection ID are distributed to the same backend server.
  • iqch: consistent hashing that is based on specific three bytes of the iQUIC CIDs. Requests whose second to fourth bytes are the same are distributed to the same backend server.
wrr
HealthCheckstringYes

Specifies whether to enable the health check feature. Valid values:

  • on
  • off (default)
on
HealthCheckDomainstringNo

The domain name that you want to use for health checks.

Note This parameter takes effect only if you set HealthCheck to on.
www.aliyundoc.com
HealthCheckURIstringNo

The Uniform Resource Identifier (URI) that you want to use for health checks. The URI must be 1 to 80 characters in length.

Note
  • The URL must start with / and contain characters other than /.

  • This parameter takes effect only if you set HealthCheck to on.

/checkpreload.htm
HealthyThresholdintegerNo

The number of consecutive successful health checks that must occur before an unhealthy and inaccessible backend server is declared healthy and accessible. Valid values: 2 to 10. Default value: 3.

Note This parameter takes effect only if you set HealthCheck to on.
3
UnhealthyThresholdintegerNo

The number of consecutive failed health checks that must occur before a healthy and accessible backend server is declared unhealthy and inaccessible. Valid values: 2 to 10. Default value: 3.

Note This parameter takes effect only if you set HealthCheck to on.
3
HealthCheckTimeoutintegerNo

The timeout period of a health check response. If a backend server does not respond within the specified timeout period, the server fails to pass the health check.

  • Default value: 5.
  • Valid values: 1 to 300.
  • Unit: seconds.
Note
  • This parameter takes effect only if you set HealthCheck to on.

  • If the value of the HealthCheckTimeout parameter is smaller than the value of the HealthCheckInterval parameter, the timeout period specified by the HealthCheckTimeout parameter becomes invalid and the value of the HealthCheckInterval parameter is used as the timeout period.

5
HealthCheckConnectPortintegerNo

The backend port that is used for health checks. Valid values: 1 to 65535.

Note This parameter takes effect only if you set HealthCheck to on.
30040
HealthCheckIntervalintegerNo

The interval at which health checks are performed. Valid values: 1 to 50. Default value: 2. Unit: seconds.

Note This parameter takes effect only if you set HealthCheck to on.
2
HealthCheckHttpCodestringNo

The HTTP status code for a successful health check. Valid values:

  • http_2xx (default)
  • http_3xx
  • http_4xx
  • http_5xx
Note This parameter takes effect only if you set HealthCheck to on.
http_2xx
IdleTimeoutintegerNo

The timeout period for idle connections. Default value: 15. Valid values: 1 to 60. Unit: seconds.

Note If no request is received within the specified timeout period, ELB closes the connection. When a request is received, ELB creates a new connection.
15
RequestTimeoutintegerNo

The timeout period of a request. Default value: 60. Valid values: 1 to 180. Unit: seconds.

Note If no response is received from the backend server within the specified timeout period, ALB returns an HTTP 504 error code to the client.
60
HealthCheckMethodstringNo

The health check method used in HTTP health checks. Valid values:

  • head (default)
  • get
Note This parameter takes effect only if you set HealthCheck to on.
head

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error codes

HTTP status codeError codeError messageDescription
400ens.interface.errorAn error occurred while call the API.-
400Invalid%sThe specified parameter %s is invalid.-
400Missing%sYou must specify the parameter %s.-
400LoadBalancerNotFoundThe input parameter loadBalancerId that is not found.-
400IncorrectInstanceStatusThe current status of the resource does not support this operation.The current operation is not supported. The disk is being reset.
400ListenerAlreadyExistsThe listenerPort already exists.-
400NoPermissionPermission denied.-
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history