CreateListener
Region:
China (Hangzhou)
Request Parameters
Required
RegionIdThe ID of the regio...
AcceleratorIdThe ID of the GA in...
NameThe name of the lis...
DescriptionThe description of ...
ClientAffinitySpecifies whether t...
ProtocolThe network transmi...
PortRangesThe listener ports
0The listener ports
FromPortThe first port of t...
ToPortThe last port of th...
CertificatesThe SSL certificates
0The SSL certificates
IdThe ID of the SSL c...
XForwardedForConfigThe XForward headers
XForwardedForGaIdEnabledSpecifies whether t...
Please select a Boolean value
XForwardedForGaApEnabledSpecifies whether t...
Please select a Boolean value
XForwardedForProtoEnabledSpecifies whether t...
Please select a Boolean value
XForwardedForPortEnabledSpecifies whether t...
Please select a Boolean value
XRealIpEnabledSpecifies whether t...
Please select a Boolean value
SecurityPolicyIdThe ID of the secur...
TypeThe routing type of...
EndpointGroupConfigurationsThe endpoint groups...
0The endpoint group ...
EndpointGroupNameThe name of the end...
EndpointGroupDescriptionThe description of ...
EndpointGroupRegionThe region ID of th...
TrafficPercentageThe traffic distrib...
HealthCheckEnabledSpecifies whether t...
Please select a Boolean value
HealthCheckIntervalSecondsThe interval at whi...
HealthCheckPathThe health check path
HealthCheckPortThe port that you w...
HealthCheckProtocolThe protocol over w...
ThresholdCountThe number of faile...
EndpointConfigurationsThe endpoints that ...
0The endpoint that i...
TypeThe type of the end...
WeightThe weight of the e...
EndpointThe IP address or d...
SubAddressThe private IP addr...
EnableClientIPPreservationSpecifies whether t...
Please select a Boolean value
EnableProxyProtocolSpecifies whether t...
Please select a Boolean value
VpcIdThe virtual private...
VSwitchIdsThe IDs of vSwitche...
0The vSwitch IDs
EndpointRequestProtocolThe backend service...
EndpointProtocolVersionThe backend service...
EndpointGroupTypeThe type of the end...
PortOverridesThe port mappings
0The port mapping
ListenerPortThe listener port t...
EndpointPortThe endpoint port t...
CustomRoutingEndpointGroupConfigurationsThe endpoint group ...
0The endpoint group ...
EndpointGroupRegionThe region ID of th...
NameThe name of the end...
DescriptionThe description of ...
DestinationConfigurationsThe mapping configu...
0The mapping configu...
ProtocolsThe protocol used b...
0The backend service...
FromPortThe start port used...
ToPortThe end port used b...
EndpointConfigurationsThe endpoints that ...
0The endpoint that i...
TypeThe service type of...
EndpointThe name of the vSw...
TrafficToEndpointPolicyThe traffic policy ...
PolicyConfigurationsThe destinations in...
0The destination in ...
AddressThe IP address of t...
PortRangesThe port ranges of ...
0The port range of t...
FromPortThe start port of t...
ToPortThe end port of the...
IdleTimeoutThe timeout period ...
RequestTimeoutThe timeout period ...
HttpVersionThe maximum version...
Idempotence Parameters
ClientTokenThe client token th...
Plugin DownloadLearn more
VS Code Plugin
Before installing the plugin, please install VS CodeBefore installing the plugin, please install VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains Plugin
Before installing the plugin, please install JetBrains IDEBefore installing the plugin, please install JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

Operation Description

When you call this operation, take note of the following items:

  • CreateListener is an asynchronous operation. After a request is sent, the system returns a request ID and runs the task in the background. You can call the DescribeListener operation to query the status of the task.

    • If the listener is in the init state, the listener is being created. In this state, you can perform only query operations.
    • If the listener is in the active state, the listener is created.
  • You cannot repeatedly call the CreateListener operation for the same GA instance within the specified period of time.

Request Parameters

Field NameField Details
RegionIdstring

The ID of the region where the GA instance is deployed. Set the value to cn-hangzhou.

Example:cn-hangzhou
ClientTokenstring

The client token that is used to ensure the idempotence of the request.View Details...

Example:123e4567-e89b-12d3-a456-426655440000
AcceleratorIdstring

The ID of the GA instance.

Example:ga-bp1odcab8tmno0hdq****Reference Value Source:
    ListAccelerators
    CreateAccelerator
    UpdateAcceleratorAutoRenewAttribute
Namestring

The name of the listener.View Details...

Example:Listener
Descriptionstring

The description of the listener.View Details...

Example:Listener
ClientAffinitystring

Specifies whether to enable client affinity for the listener.View Details...

Example:SOURCE_IP
Protocolstring

The network transmission protocol that you want to use for the listener. Valid values:View Details...

Example:tcp
PortRangesarray<object>

The listener ports. Valid values: 1 to 65499. The maximum number of ports that can be configured depends on the routing type and protocol of the listener. For more information, see Listener overview.

Count of Children <= 100
Certificatesarray<object>

The SSL certificates.

Count of Children <= 10
XForwardedForConfigobject

The XForward headers.

SecurityPolicyIdstring

The ID of the security policy. Valid values:View Details...

Example:tls_cipher_policy_1_0Reference Value Source:
    ListSystemSecurityPolicies
Typestring

The routing type of the listener. Valid values:View Details...

Example:StandardReference Value Source:
    ListIspTypes
EndpointGroupConfigurationsarray<object>

The endpoint groups that are associated with the intelligent routing listener.View Details...

CustomRoutingEndpointGroupConfigurationsarray<object>

The endpoint group that is associated with the custom routing listener.View Details...

IdleTimeoutinteger<int32>

The timeout period of idle connections. Unit: seconds.View Details...

Example:900
RequestTimeoutinteger<int32>

The timeout period for HTTP or HTTPS requests. Unit: seconds.View Details...

Example:15
HttpVersionstring

The maximum version of the HTTP protocol. Valid values:View Details...

Example:http2

Response Parameters

Field NameField Details
RequestIdstring

The ID of the request.

Example:04F0F334-1335-436C-A1D7-6C044FE73368
ListenerIdstring

The ID of the listener.

Example:lsr-bp1bpn0kn908w4nbw****
Change History
No Change History found.