
Quotas Info
Authorization Information
The following table shows the authorization information corresponding to this API, which can be used in the Action policy element to grant a RAM user or RAM role the permissions to call the API. Please use RAM to set up these permissions and refer to RAM documentation for more instructions.
Request Parameters
Field Name | Field Details |
---|---|
ListenerIdstring | The ID of the listener. Example:lsn-bp1bpn0kn908w4nbw****@233Reference Value Source: ListListeners CreateListener |
DryRunboolean | Specifies whether to perform a dry run, without sending the actual request. Valid values:View Details... Example:false |
ClientTokenstring | The client token that is used to ensure the idempotence of the request.View Details... Example:123e4567-e89b-12d3-a456-426655440000 |
RegionIdstring | The ID of the region where the Network Load Balancer (NLB) instance is deployed.View Details... Example:cn-hangzhouReference Value Source: DescribeRegions SetHdMonitorRegionConfig |
Response Parameters
Field Name | Field Details |
---|---|
RequestIdstring | The ID of the request. Example:CEF72CEB-54B6-4AE8-B225-F876FF7BA984 |
RegionIdstring | The ID of the region where the NLB instance is deployed. Example:cn-hangzhou |
LoadBalancerIdstring | The ID of the NLB instance. Example:nlb-83ckzc8d4xlp8o**** |
ListenerIdstring | The ID of the listener. Example:lsn-bp1bpn0kn908w4nbw****@233 |
ListenerProtocolstring | The listening protocol. Valid values: TCP, UDP, and TCPSSL. Example:TCPSSL |
ListenerPortinteger<int32> | The listening port. Valid values: 0 to 65535. A value of 0 specifies all ports. If you set the value to 0, you must also set the StartPort and EndPort parameters. Example:233 |
StartPortstring | The first port in the listening port range. Valid values: 0 to 65535. Example:233 |
EndPortstring | The last port in the listening port range. Valid values: 0 to 65535. The number of the last port must be smaller than that of the first port. Example:455 |
ListenerDescriptionstring | The name of the listener.View Details... Example:tcpssl_443 |
ServerGroupIdstring | The ID of the server group. Example:sgp-ppdpc14gdm3x4o**** |
IdleTimeoutinteger<int32> | The timeout period of an idle connection. Unit: seconds. Valid values: 1 to 900. Example:900 |
SecurityPolicyIdstring | The ID of the security policy. System security policies and custom security policies are supported.View Details... Example:tls_cipher_policy_1_0 |
CertificateIdsarray<string> | The server certificates. Only one server certificate is supported.View Details... |
CaCertificateIdsarray<string> | The CA certificates. Only one CA certificate is supported.View Details... |
CaEnabledboolean | Indicates whether mutual authentication is enabled. Valid values:View Details... Example:false |
AlpnEnabledboolean | Indicates whether Application-Layer Protocol Negotiation (ALPN) is enabled. Valid values:View Details... Example:false |
AlpnPolicystring | The ALPN policy. Valid values:View Details... Example:HTTP1Only |
ProxyProtocolEnabledboolean | Indicates whether the Proxy protocol is used to pass client IP addresses to backend servers. Valid values:View Details... Example:false |
ProxyProtocolV2Configobject | Indicates whether the Proxy protocol passes the VpcId, PrivateLinkEpId, and PrivateLinkEpsId parameters to backend servers. |
SecSensorEnabledboolean | Indicates whether fine-grained monitoring is enabled. Valid values:View Details... Example:false |
ListenerStatusstring | The status of the listener. Valid values:View Details... Example:Running |
Cpsinteger<int32> | The maximum number of new connections per second supported by the listener in each zone (virtual IP address). Valid values: 0 to 1000000. 0 indicates that the number of connections is unlimited. Example:1000 |
Mssinteger<int32> | The size of the largest TCP segment. Unit: bytes. Valid values: 0 to 1500. 0 specifies that the maximum segment size remains unchanged.View Details... Example:166 |
Tagsarray<object> | The tags. |