Appendix

Definition of model object

BLBModel

Parameter name	Types	Description
blbId	String	LoadBalancer identifier
name	String	LoadBalancer name
desc	String	LoadBalancer description
address	String	Assigned Intranet server address IP, through which the instance can be accessed via the Intranet
status	blbStatus	BLB status
vpcId	String	VPC ID
subnetId	String	Subnet ID
publicIp	String	This item is displayed if the Load Balancer is bound to an EIP; otherwise, it is not displayed
tags	List<TagModel>	List of tag key-value pairs
allowDelete	Boolean	Is deletion allowed
eipRouteType	String	EIP Internet connection type
publicIpv6	String	This item is displayed if the Load Balancer is bound to an EIPv6; otherwise, it is not displayed
eipV6RouteType	String	EIPV6 Internet Connection Type
paymentTiming	String	Charge type values: "Postpaid" for postpayment and "Prepaid" for prepayment.
billingMethod	String	Charge type values: "ByCapacityUnit" for pay-as-you-go mode, and "BySpec" for fixed specification mode.

TCPListenerModel

Parameter name	Types	Description
listenerPort	int	Listener port
backendPort	int	Real server listener port
scheduler	String	Load balancer algorithm with the values of "RoundRobin"/"WeightLeastConn"/"Hash", among which "RoundRobin" means weighted round-robin, "WeightLeastConn" means weighted minimum connection counts, and "Hash" means source IP-based hashing.
healthCheckTimeoutInSecond	int	Health check timeout
healthCheckInterval	int	Health check interval
unhealthyThreshold	int	Unhealthy threshold, i.e., the number of consecutive health check failures after which the real server is blocked.
healthyThreshold	int	Healthy threshold, i.e., the number of consecutive successful health checks after which the real server can be set as available again.
tcpSessionTimeout	int	TCP connection timeout duration setting (unit: second). It is 900 by default, and shall be an integer between 10 and 4000.

UDPListenerModel

Parameter name	Types	Description
listenerPort	int	Listener port
backendPort	int	Real server listener port
scheduler	String	Load balancer algorithm with the values of "RoundRobin"/"WeightLeastConn"/"Hash", among which "RoundRobin" means weighted round-robin, "WeightLeastConn" means weighted minimum connection counts, and "Hash" means source IP-based hashing.
healthCheckType	String	Health check protocol, with the values of "UDP"/"ICMP".
healthCheckTimeoutInSecond	int	Health check timeout
healthCheckInterval	int	Health check interval
unhealthyThreshold	int	Unhealthy threshold, i.e., the number of consecutive health check failures after which the real server is blocked.
healthyThreshold	int	Healthy threshold, i.e., the number of consecutive successful health checks after which the real server can be set as available again.
healthCheckString	String	The health check request string sent to the real server requires a response upon receipt. It supports standard escape sequences such as \00 and \xf2, facilitating the configuration of binary format requests.
udpSessionTimeout	int	UDP session timeout duration. The default is 90 seconds, but it can be set as an integer between 5 and 4000 seconds.

HTTPListenerModel

Parameter name	Types	Description
listenerPort	int	Listener port
backendPort	int	Real server listener port
scheduler	String	Load balancer algorithm, with the values of "RoundRobin"/"LeastConnection"
keepSession	bool	Whether to enable the session persistence function, meaning requests from the same client will be sent to the same real server.
keepSessionType	String	Cookie handling method for session persistence, valid only when the session persistence is enabled, with values of "insert"/"rewrite".
keepSessionDuration	int	Validity period of session persistence cookies (unit: second), valid only when the session persistence is enabled.
keepSessionCookieName	String	Cookie name to be overwritten for session persistence, valid only when the session persistence is enabled and keepSessionType="rewrite".
xForwardFor	bool	Whether to enable retrieving the real IP of the client. Once it is enabled, the real server can retrieve the real IP address of the client via the HTTP Header X-Forwarded-For.
healthCheckType	String	Health check protocol, with the values of "HTTP"/"TCP".
healthCheckPort	int	Health check port
healthCheckURI	String	Health check URI
healthCheckTimeoutInSecond	int	Health check timeout
healthCheckInterval	int	Health check interval
unhealthyThreshold	int	Unhealthy threshold, i.e., the number of consecutive health check failures after which the real server is blocked.
healthyThreshold	int	Healthy threshold, i.e., the number of consecutive successful health checks after which the real server can be set as available again.
healthCheckNormalStatus	String	HTTP status codes for successful health checks, supporting combinations of 5 types of status codes in the format of http_1xx or http_2xx.
healthCheckHost	String	The header field of the Layer 7 health check request will include the specified host field, such as "localhost," with the default being an empty string (""). This is valid only when the health check protocol is "HTTP".
serverTimeout	int	Maximum timeout duration for real servers (unit: second)
redirectPort	int	Requests received by this listener is forwarded to the HTTPS listener, which is specified through this port.

HTTPSListenerModel

Parameter name	Types	Description
listenerPort	int	Listener port
backendPort	int	Real server listener port
scheduler	String	Load balancer algorithm, with the values of "RoundRobin"/"LeastConnection"
keepSession	bool	Whether to enable the session persistence function, meaning requests from the same client will be sent to the same real server.
keepSessionType	String	Cookie handling method for session persistence, valid only when the session persistence is enabled, with values of "insert"/"rewrite".
keepSessionDuration	int	Validity period of session persistence cookies (unit: second), valid only when the session persistence is enabled.
keepSessionCookieName	String	Cookie name to be overwritten for session persistence, valid only when the session persistence is enabled and keepSessionType="rewrite".
xForwardFor	bool	Whether to enable retrieving the real IP of the client. Once it is enabled, the real server can retrieve the real IP address of the client via the HTTP Header X-Forwarded-For.
healthCheckType	String	Health check protocol, with the values of "HTTP"/"TCP".
healthCheckPort	int	Health check port
healthCheckURI	String	Health check URI
healthCheckTimeoutInSecond	int	Health check timeout
healthCheckInterval	int	Health check interval
unhealthyThreshold	int	Unhealthy threshold, i.e., the number of consecutive health check failures after which the real server is blocked.
healthyThreshold	int	Healthy threshold, i.e., the number of consecutive successful health checks after which the real server can be set as available again.
healthCheckNormalStatus	String	HTTP status codes for successful health checks, supporting combinations of 5 types of status codes in the format of http_1xx or http_2xx.
healthCheckHost	String	The header field of the Layer 7 health check request will include the specified host field, such as "localhost", and the default is "". It is valid when the health check protocol is "HTTP".
serverTimeout	int	Maximum timeout duration for real servers (unit: second)
certIds	List	Loaded SSL certificate. Currently, the HTTPS listeners can only be bound to one SSL certificate.
additionalCertDomains	List<[AdditionalCertDomain](BLB/API Reference/Appendix.md#AdditionalCertDomain)>	Extended domain name
dualAuth	bool	Whether to enable mutual authentication, and it is disabled by default.
clientCertIds	List	It is the loaded client certificate chain when dualAuth is true.
encryptionType	String	Encryption type
encryptionProtocols	List	Encryption protocol
appliedCiphers	String	Cipher suite

SSLListenerModel

Parameter name	Types	Description
listenerPort	int	Listener port
backendPort	int	Real server listener port
scheduler	String	Load balancer algorithm with the values of "RoundRobin"/"LeastConnection"/"Hash", among which "RoundRobin" means weighted round-robin, "LeastConnection" means minimum connection counts, and "Hash" means source IP-based hashing.
healthCheckTimeoutInSecond	int	Health check timeout
healthCheckInterval	int	Health check interval
unhealthyThreshold	int	Unhealthy threshold, i.e., the number of consecutive health check failures after which the real server is blocked.
healthyThreshold	int	Healthy threshold, i.e., the number of consecutive successful health checks after which the real server can be set as available again.
certIds	List	Loaded SSL certificate chain
encryptionType	String	Encryption type
encryptionProtocols	List	Encryption protocol
appliedCiphers	String	Cipher suite
dualAuth	boolean	Whether to enable mutual authentication, and it is disabled by default.
clientCertIds	List	It is the loaded client certificate chain when dualAuth is true.
serverTimeout	int	Real server maximum timeout (unit: second). It is 900 s by default, and shall be an integer between 10 and 4000.

BackendServerModel

Parameter name	Types	Description
instanceId	String	Real server identifier
weight	int	Real server weight, value range: [0, 100], where weight 0 means no traffic should be forwarded to this real server.

BackendServerStatus

Parameter name	Types	Description
instanceId	String	Real server identifier
weight	int	Real server weight
status	String	Real server health status, values: "Alive"/"Dead"/"Unknown"

AppBLBModel

Parameter name	Types	Description
blbId	String	LoadBalancer identifier
name	String	LoadBalancer name
desc	String	LoadBalancer description
address	String	Load balancer address in dotted decimal notation
status	blbStatus	BLB status
subnetId	String	Subnet ID
vpcId	String	Short VPC ID
publicIp	String	This item is displayed if the Load Balancer is bound to an EIP; otherwise, it is not displayed
tags	List	List of tag key-value pairs
allowDelete	Boolean	Is deletion allowed
eipRouteType	String	EIP Internet connection type
publicIpv6	String	This item is displayed if the Load Balancer is bound to an EIPv6; otherwise, it is not displayed
eipV6RouteType	String	EIPV6 Internet Connection Type
paymentTiming	String	Charge type values: "Postpaid" for postpayment and "Prepaid" for prepayment.
billingMethod	String	Charge type values: "ByCapacityUnit" for pay-as-you-go mode, and "BySpec" for fixed specification mode.

TagModel

Parameter name	Types	Description
tagKey	String	The key of the tag, which main contain uppercase and lowercase letters, numbers, Chinese characters, and special characters-_ /., with a length of 1-65.
tagValue	String	The value of the tag, which main contain uppercase and lowercase letters, numbers, Chinese characters, and special characters-_ /., with a length of 0-65.

ListenerModel

Parameter name	Types	Description
port	String	Listener port
type	String	Listener protocol type
description	String	Description limited to a maximum of 200 characters.

AppTCPListenerModel

Parameter name	Types	Description
listenerPort	int	Listener port
scheduler	String	Load balancer algorithm with the values of "RoundRobin"/"WeightLeastConn"/"Hash", among which "RoundRobin" means weighted round-robin, "WeightLeastConn" means weighted minimum connection counts, and "Hash" means source IP-based hashing.
tcpSessionTimeout	int	TCP connection timeout duration setting (unit: second). It is 900 by default, and shall be an integer between 10 and 4000.
description	String	Description limited to a maximum of 200 characters.

AppUDPListenerModel

Parameter name	Types	Description
listenerPort	int	Listener port
scheduler	String	Load balancer algorithm with the values of "RoundRobin"/"WeightLeastConn"/"Hash", among which "RoundRobin" means weighted round-robin, "WeightLeastConn" means weighted minimum connection counts, and "Hash" means source IP-based hashing.
description	String	Description limited to a maximum of 200 characters.

AppHTTPListenerModel

Parameter name	Types	Description
listenerPort	int	Listener port
scheduler	String	Load balancer algorithm, values: "RoundRobin"/"LeastConnection", among which "RoundRobin" means weighted round-robin, and "LeastConnection" means minimum connection counts.
keepSession	boolean	Whether to enable the session persistence function, meaning requests from the same client will be sent to the same real server.
keepSessionType	String	Cookie handling method for session persistence, valid only when the session persistence is enabled, with values of "insert"/"rewrite".
keepSessionTimeout	int	Validity period of session persistence cookies (unit: second), valid only when the session persistence is enabled.
keepSessionCookieName	String	Cookie name to be overwritten for session persistence, valid only when the session persistence is enabled and keepSessionType="rewrite".
xForwardedFor	boolean	Whether to enable retrieving the real IP of the client. Once it is enabled, the real server can retrieve the real IP address of the client via the HTTP Header X-Forwarded-For.
xForwardedProto	boolean	Whether to enable retrieving listener protocol. Once it is enabled, real servers can acquire the listener protocol via the X-Forwarded-Proto HTTP Header.
serverTimeout	int	Maximum timeout duration for real servers (unit: second)
redirectPort	int	Requests received by this listener is forwarded to the HTTPS listener, which is specified through this port.
description	String	Description limited to a maximum of 200 characters.

AppHTTPSListenerModel

Parameter name	Types	Description
listenerPort	int	Listener port
scheduler	String	Load balancer algorithm, values: "RoundRobin"/"LeastConnection", among which "RoundRobin" means weighted round-robin, and "LeastConnection" means minimum connection counts.
keepSession	boolean	Whether to enable the session persistence function, meaning requests from the same client will be sent to the same real server.
keepSessionType	String	Cookie handling method for session persistence, valid only when the session persistence is enabled, with values of "insert"/"rewrite".
keepSessionTimeout	int	Validity period of session persistence cookies (unit: second), valid only when the session persistence is enabled.
keepSessionCookieName	String	Cookie name to be overwritten for session persistence, valid only when the session persistence is enabled and keepSessionType="rewrite".
xForwardedFor	boolean	Whether to enable retrieving the real IP of the client. Once it is enabled, the real server can retrieve the real IP address of the client via the HTTP Header X-Forwarded-For.
xForwardedProto	boolean	Whether to enable retrieving listener protocol. Once it is enabled, real servers can acquire the listener protocol via the X-Forwarded-Proto HTTP Header.
serverTimeout	int	Maximum timeout duration for real servers (unit: second)
certIds	List	Loaded SSL certificate chain
additionalCertDomains	List<[AdditionalCertDomain](BLB/API Reference/Appendix.md#AdditionalCertDomain)>	Extended domain name
encryptionType	String	Encryption type
encryptionProtocols	List	Encryption protocol
appliedCiphers	String	Cipher suite
dualAuth	boolean	Whether to enable mutual authentication, and it is disabled by default.
clientCertIds	List	It is the loaded client certificate chain when dualAuth is true.
description	String	Description limited to a maximum of 200 characters.

AppSSLListenerModel

Parameter name	Types	Description
listenerPort	int	Listener port
scheduler	String	Load balancer algorithm with the values of "RoundRobin"/"LeastConnection"/"Hash", among which "RoundRobin" means weighted round-robin, "LeastConnection" means minimum connection counts, and "Hash" means source IP-based hashing.
certIds	List	Loaded SSL certificate chain
encryptionType	String	Encryption type
encryptionProtocols	List	Encryption protocol
appliedCiphers	String	Cipher suite
dualAuth	boolean	Whether to enable mutual authentication, and it is disabled by default.
clientCertIds	List	It is the loaded client certificate chain when dualAuth is true.
description	String	Description limited to a maximum of 200 characters.

AppBackendServer

Parameter name	Types	Description
instanceId	String	Real server identifier
weight	int	Real server weight, value range: 0-100
privateIp	String	Response value during the query: The bound real server IP address
portList	List<AppRsPortModel>	Response value during the query: The port list opened by RS with corresponding policies set.

AppRsPortModel

Parameter name	Types	Description
listenerPort	int	Listener port (the listener port associated with the backend port)
backendPort	String	Open ports at the backend
portType	String	Port protocol type (the port type opened by the server group, including TCP, UDP, HTTP and HTTPS)
healthCheckPortType	String	Health check port protocol types (TCP, UDP, ICMP, HTTP and HTTPS)
status	String	Port status: "Alive"/"Dead"/"Unknown"
portId	String	Port ID
policyId	String	Corresponding policy ID

AppServerGroup

Parameter name	Types	Description
id	String	Real server group identifier
name	String	Real server group name
desc	String	Real server group description
status	String	Server group status. See details in blbStatus.
portList	List<AppServerGroupPort>	List of open ports of server groups

AppServerGroupPort

Parameter name	Types	Description
id	String	Port identifier of server group
port	int	Open port No. of server group
type	String	Port protocol type, supporting "TCP"/"HTTP"
status	String	Server group status. See details in blbStatus.
healthCheck	String	Health check protocol, supporting "HTTP"/"TCP"
healthCheckPort	int	Health check port
healthCheckTimeoutInSecond	int	Health check timeout duration (unit: second). It is 3 by default, and shall be an integer between 1 and 60.
healthCheckIntervalInSecond	int	Health check interval (unit: second). It is 3 by default, and shall be an integer between 1 and 10.
healthCheckDownRetry	int	Unhealthy threshold represents the number of consecutive health check failures required to block the real server. Default is 3, and it must be an integer between 2 and 5.
healthCheckUpRetry	int	Healthy threshold represents the number of consecutive successful health checks required to set the real server as available. Default is 3, and it must be an integer between 2 and 5.
healthCheckNormalStatus	String	HTTP status codes for successful health checks support combinations of up to 5 types of codes, like "http_1xx
healthCheckUrlPath	String	Health check URI, default is /. Valid when the health check protocol is "HTTP".
healthCheckHost	String	The header field of the Layer 7 health check request will include the specified host field, such as "localhost", and the default is "". It is valid when the health check protocol is "HTTP".
udpHealthCheckString	String	UDP health check string. It is valid when the port type is UDP.

AppPolicy

Parameter name	Types	Description
id	String	Policy identifier
desc	String	Policy description is empty by default
appServerGroupId	String	Policy-bound server group identifier
appServerGroupName	String	Policy-bound server group name
frontendPort	int	Frontend server listener port
type	String	Frontend server listener port protocol
backendPort	int	Target port No. When the listenerPort corresponds to a TCP or SSL listener, enter the open TCP port No. under the corresponding server group (appServerGroupId); when the listenerPort corresponds to an HTTP or HTTPS listener, enter the open HTTP port No. under the corresponding server group (appServerGroupId); when the listenerPort corresponds to a UDP listener, enter the open UDP port No. under the corresponding server group (appServerGroupId).
portType	String	Port type
priority	int	Policy priority, the valid value range: 1-32768.
ruleList	List<AppRule>	Policy rule list
groupType	String	"Server" indicates the backend is bound to a server group.

AppPolicyForUpdate

Parameter name	Types	Required or not	Description
policyId	String	Yes	Forwarding policy ID.
priority	Integer	No	Priority, with a value range of 1 to 32,768. Must not duplicate existing entries. Lower values indicate higher priority. Rules are applied in descending order of priority. Either priority or description must be provided.
description	String	No	Description limited to a maximum of 200 characters. Either priority or description must be provided.

AppRule

Parameter name	Types	Description
id	String	Rule identifier
key	String	Rule types, such as host/uri/*
value	String	Matching string of wildcard. See ValueExample for details.

CreateAppPolicy

Parameter name	Types	Whether required	Description
appServerGroupId	String	Yes	Policy-bound server group identifier
backendPort	int	Yes	Target port No. When the listenerPort corresponds to a TCP or SSL listener, enter the open TCP port No. under the corresponding server group (appServerGroupId); when the listenerPort corresponds to an HTTP or HTTPS listener, enter the open HTTP port No. under the corresponding server group (appServerGroupId); when the listenerPort corresponds to a UDP listener, enter the open UDP port No. under the corresponding server group (appServerGroupId).
portType	String	No	Target port type. It is the protocol used by the target port No. by default when the target group is a server group.
priority	int	Yes	Policy priority, the valid value range: 1-32768.
ruleList	List<CreateAppRule>	Yes	Policy rule list
desc	String	No	Policy description is empty by default

CreateAppRule

Parameter name	Types	Whether required	Description
key	String	Yes	Rule types, such as host/uri/*
value	String	Yes	Matching string of wildcard. See ValueExample for details.

PortTypeModel

Parameter name	Types	Whether required	Description
port	int	Yes	Listener port
type	String	Yes	Listener port protocol

BillingForCreate

Parameter name	Types	Whether required	Description
paymentTiming	String	Yes	Payment time: Prepaid and Postpaid. Currently, only Prepaid is supported.
billingMethod	String	No	Charge type. It shall be entered for postpayment, with "BySpec" for fixed specification mode, and "ByCapacityUnit" for the pay-as-you-go mode.
reservation	ReservationForCreate	Yes	Reserved information, not required when payment method is Postpay, but must be set when it is Prepay

ReservationForCreate

Parameter name	Types	Whether required	Description
reservationLength	int	Yes	Purchase duration in months, [1,2,3,4,5,6,7,8,9,12,24,36]

BillingForRenew

Parameter name	Types	Whether required	Description
reservation	ReservationForCreate	Yes	Reserved information. It must be set during prepayment.

Billing

Parameter name	Types	Required or not	Description
paymentTiming	String	Yes	Payment time: Prepaid and Postpaid.
billingMethod	String	No	Charge type. It shall not be entered for prepay, and shall be entered for postpay, with fixed specification mode (BySpec) and pay-as-you-go mode (ByCapacityUnit).
reservation	Reservation	No	Reserved information, not required when payment method is Postpay, but must be set when it is Prepay

Reservation

Parameter name	Types	Required or not	Description
reservationLength	Integer	Yes	Purchase duration in months, value range: [1,2,3,4,5,6,7,8,9,12,24,36].

Price

Parameter name	Types	Description
chargeItem	String	Charge item, e.g., "instance" indicates instance fees, and "netraffic" indicates traffic fees.
discountPrice	String	Discounted price, in RMB. For example, a response value of "150" means prepay; "0.00028" means postpay.
originalPrice	String	Original price
chargeUnit	String	Charge unit for postpay, e.g., "minute". minute: Charged by minute. GB: Charged by GB. "lcu": Charged by LCU unit.

AdditionalCertDomain

Parameter name	Types	Whether required	Description
certId	String	Yes	Certificate ID
Host	String	Yes	Certificate domain name. For wildcard domain name certificates, supports wildcard domains and their subdomains.

ClusterModel

Parameter name	Types	Description
id	String	Cluster ID
name	String	Cluster name
type	String	Cluster type
status	String	Cluster status
ccuCount	int	Cluster performance capacity
createTime	String	Cluster creation time
expireTime	String	Cluster expiration time
desc	String	Description

AssociateBlbModel

Parameter name	Types	Description
blbId	String	Load Balancer ID
name	String	BLB name
status	String	BLB status
blbType	String	BLB type
publicIp	String	Public IP
eipRouteType	String	EIP Internet connection type
bandwidth	int	Bandwidth
address	String	Internet IP address
ipv6	String	ipv6 address
vpcId	String	vpcId
subnetId	String	Subnet ID

BlbSecurityGroupModel

Parameter name	Types	Description
securityGroupId	String	Regular security group ID
securityGroupName	String	Regular security group name
securityGroupDesc	String	Regular security group description
vpcName	String	Virtual Private Cloud (VPC) name
securityGroupRules	List<BlbSecurityGroupRuleModel>	Regular security group rule

BlbSecurityGroupRuleModel

Parameter name	Types	Description
securityGroupRuleId	String	Regular security group rule ID
direction	String	Ingress/egress: ingress or egress
ethertype	String	Network type, values: IPv4 or Ipv6. The parameter is IPv4 by default when it is empty.
portRange	String	Port range, a single port like 80 can be designated, defaulting to 1-65535 when the value is null.
protocol	String	Protocol type: tcp, udp, or icmp. Default to "all" when the value is null.
sourceGroupId	String	Source security group ID
sourceIp	String	Source IP address, cannot be set simultaneously with sourceGroupId.
destGroupId	String	Destination security group ID
destIp	String	Destination IP address, cannot be set simultaneously with destGroupId.

BlbEnterpriseSecurityGroupModel

Parameter name	Types	Description
enterpriseSecurityGroupId	String	Enterprise security group ID
enterpriseSecurityGroupName	String	Enterprise security group name
enterpriseSecurityGroupDesc	String	Enterprise security group description
enterpriseSecurityGroupRules	List<BlbEnterpriseSecurityGroupRuleModel>	Enterprise security group rule

BlbEnterpriseSecurityGroupRuleModel

Parameter name	Types	Description
remark	String	Remarks, with a length range of 1-255 characters.
direction	String	Ingress/Egress: either ingress or egress.
ethertype	String	The network type, which can be either IPv4 or IPv6. When this value is null, it defaults to IPv4.
portRange	String	Port range, supporting continuous ports (e.g., "1-80") or discrete ports (e.g., "80,7000,8000", separated by commas, up to 15 discrete values). Default range is 1-65535 when unspecified.
protocol	String	Protocol type: TCP, UDP, or ICMP. Defaults to "all" if no value is provided.
sourceIp	String	Source IP address. "all" indicates all.
destIp	String	Destination IP Address. "all" indicates all.
action	String	Allowed values: "allow" or "deny".
priority	Integer	Priority, with a value range of 1-1000.
enterpriseSecurityGroupRuleId	String	Enterprise security group rule ID

Rule configuration example

ValueExample

key	value	Description
*	*	Exact match
host	*.baidu.com	Match domain names ending with ".baidu.com".
uri	/abc/def.*	Match URI paths starting with "/abc/def".

Status code definitions

blbStatus

Status	Description
creating	Creating
available	Running
updating	Updating
paused	In debt
unavailable	Unavailable temporarily

Encryption type, encryption protocol and cipher suite

encryption

encryptionType (encryption type)	encryptionProtocols (encryption protocol)	appliedCiphers (cipher suite)
tls_cipher_policy_default	["tlsv10", "tlsv11", "tlsv12"]	ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES128-SHA:AES128-GCM-SHA256:AES256-SHA:AES128-SHA:AES256-GCM-SHA384:AES256-SHA256:AES128-SHA256:DES-CBC3-SHA
tls_cipher_policy_1_1	["tlsv11", "tlsv12"]	It is the same as tls_cipher_policy_default
tls_cipher_policy_1_2	["tlsv12"]	It is the same as tls_cipher_policy_default
tls_cipher_policy_1_2_secure	["tlsv12"]	ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA:ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES128-SHA256:ECDHE-ECDSA-AES128-SHA:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES128-SHA

All listener type fields. Specific response values depend on the listener type.

AllListenerModel

Parameter name	Types	Description l
listenerPort	int	Listener port
listenerType	String	Listener type
backendPort	int	Real server listener port
scheduler	String	Load balancer algorithm with the values of "RoundRobin"/"LeastConnection"/"WeightLeastConn"/"Hash", among which "RoundRobin" means weighted round-robin, "LeastConnection” means minimum connection counts, "WeightLeastConn" means weighted minimum connection counts and "Hash" means source IP-based hashing.
healthCheckTimeoutInSecond	int	Health check timeout duration
healthCheckInterval	int	Health check interval
healthyThreshold	int	Healthy threshold, i.e., the number of consecutive successful health checks after which the real server can be set as available again.
unhealthyThreshold	int	Unhealthy threshold, i.e., the number of consecutive health check failures after which the real server is blocked.
getBlbIp	bool	open-api is available as an implicit parameter for specific users with needs. Currently, it can only be set for TCP types, with other types being false by default. Once it is enabled, when Layer 4 data reaches the VM, the VM can retrieve the original BLB IP (VIP/OVIP) information via tcp_option.
tcpSessionTimeout	int	Set TCP connection timeout duration (unit: second)
udpSessionTimeout	int	UDP session timeout duration (unit: second)
healthCheckString	String	UDP health check request string
keepSession	bool	Whether to enable the session persistence function, meaning requests from the same client will be sent to the same real server.
keepSessionType	String	Cookie handling method for session persistence, valid only when the session persistence is enabled.
keepSessionDuration	int	Validity period of session persistence cookies (unit: second), valid only when the session persistence is enabled.
keepSessionCookieName	String	Cookie name to be overwritten for session persistence, valid only when the session persistence is enabled and keepSessionType="rewrite".
xForwardFor	bool	Whether to enable retrieving the real IP of the client. Once it is enabled, the real server can retrieve the real IP address of the client via the HTTP Header X-Forwarded-For.
healthCheckType	String	Health check protocol type
healthCheckPort	int	Health check port
healthCheckURI	String	Health check URI
healthCheckNormalStatus	String	HTTP status codes for successful health checks, supporting combinations of 5 types of status codes in the format of http_1xx or http_2xx.
healthCheckHost	String	The header field of the Layer 7 health check request will include the specified host field, such as "localhost", and the default is "". It is valid when the health check protocol is "HTTP".
serverTimeout	int	Maximum timeout duration for real servers (unit: second)
redirectPort	int	Requests received by this listener is forwarded to the HTTPS listener, which is specified through this port.
certIds	List	Loaded SSL certificate. Currently, the HTTPS listeners can only be bound to one SSL certificate.
dualAuth	bool	Whether to enable mutual authentication, and it is disabled by default.
clientCertIds	List	It is the loaded client certificate chain when dualAuth is true.
encryptionType	String	Encryption type
encryptionProtocols	List	Encryption protocol
appliedCiphers	String	Cipher suite

AppListenerModel

Parameter name	Types	Description
listenerPort	int	Listener port
listenerType	String	Listener type
scheduler	String	Load balancer algorithm with the values of "RoundRobin"/"LeastConnection"/"WeightLeastConn"/"Hash", among which "RoundRobin" means weighted round-robin, "LeastConnection” means minimum connection counts, "WeightLeastConn" means weighted minimum connection counts and "Hash" means source IP-based hashing.
tcpSessionTimeout	int	Set TCP connection timeout duration (unit: second)
udpSessionTimeout	int	Set UDP connection timeout duration (unit: second)
keepSession	bool	Whether to enable the session persistence function, meaning requests from the same client will be sent to the same real server.
keepSessionType	String	Cookie handling method for session persistence, valid only when the session persistence is enabled.
keepSessionTimeout	int	Validity period of session persistence cookies (unit: second), valid only when the session persistence is enabled.
keepSessionCookieName	String	Cookie name to be overwritten for session persistence, valid only when the session persistence is enabled and keepSessionType="rewrite".
xForwardFor	bool	Whether to enable retrieving the real IP of the client. Once it is enabled, the real server can retrieve the real IP address of the client via the HTTP Header X-Forwarded-For.
xForwardedProto	bool	Whether to enable retrieving listener protocol. Once it is enabled, real servers can acquire the listener protocol via the X-Forwarded-Proto HTTP Header.
serverTimeout	int	Maximum timeout duration for real servers (unit: second)
redirectPort	int	Requests received by this listener is forwarded to the HTTPS listener, which is specified through this port.
certIds	List	Loaded SSL certificate. Currently, the HTTPS listeners can only be bound to one SSL certificate.
dualAuth	bool	Whether to enable mutual authentication, and it is disabled by default.
clientCertIds	List	It is the loaded client certificate chain when dualAuth is true.
encryptionType	String	Encryption type
encryptionProtocols	List	Encryption protocol
appliedCiphers	String	Cipher suite

Auth

Parameter name	Types	Description
uid	String	User ID, with "*" for all users.
auth	String	Authentication method, with the values of "allow/deny" indicating allow/deny respectively.

Service

Parameter name	Types	Description
serviceId	String	Service distribution point ID
name	String	Service distribution point name
description	String	Description
serviceName	String	Service name
bindType	String	Bound service type. Currently, binding BLB instances is supported only.
instanceId	String	Bound instance ID
status	String	Distribution point status, with values of inService/available/unavailable/dead/free, representing, indicating it is in service/available/unavailable/faulty/unbound.
service	String	Unique corresponding domain name of the service distribution point
createTime	String	Creation time
endpointCount	int	Count of associated service network interface card
endpointList	List<RelatedEndpoint>	List of associated service network interface card
authList	List<Auth>	Authorization list

RelatedEndpoint

Parameter name	Types	Description
endpointId	String	Service network interface card ID
uid	String	Corresponding user ID of service network interface card
attachTime	String	Association time