search by keyword

Recent Pages

Documentation
Documentation

Data Types

Last updated: 2020-07-03 17:33:47

AssociationItem

Rule associated with target group

Used by actions: DescribeTargetGroupList、DescribeTargetGroups.

Name Type Description
LoadBalancerId String ID of associated CLB instance
ListenerId String ID of associated listener
LocationId String ID of associated forwarding rule
Note: this field may return null, indicating that no valid values can be obtained.
Protocol String Protocol type of associated listener, such as HTTP or TCP
Port Integer Port of associated listener
Domain String Domain name of associated forwarding rule
Note: this field may return null, indicating that no valid values can be obtained.
Url String URL of associated forwarding rule
Note: this field may return null, indicating that no valid values can be obtained.
LoadBalancerName String CLB instance name
ListenerName String Listener name

Backend

Details of a real server bound to a listener

Used by actions: DescribeTargets.

Name Type Description
Type String Real server type. Value range: CVM, ENI (coming soon)
InstanceId String Unique ID of a real server, which can be obtained from the unInstanceId field in the return of the DescribeInstances API
Port Integer Listening port of a real server
Weight Integer Forwarding weight of a real server. Value range: [0, 100]. Default value: 10.
PublicIpAddresses Array of String Public IP of a real server
Note: This field may return null, indicating that no valid values can be obtained.
PrivateIpAddresses Array of String Private IP of a real server
Note: This field may return null, indicating that no valid values can be obtained.
InstanceName String Real server instance names
Note: This field may return null, indicating that no valid values can be obtained.
RegisteredTime String Bound time of a real server
Note: This field may return null, indicating that no valid values can be obtained.
EniId String Unique ENI ID
Note: This field may return null, indicating that no valid values can be obtained.

BasicTargetGroupInfo

Basic information of a target group bound to a forwarding rule or a listener

Used by actions: DescribeListeners、DescribeRewrite.

Name Type Description
TargetGroupId String Target group ID
TargetGroupName String Target group name

BatchTarget

Batch binding type

Used by actions: BatchDeregisterTargets、BatchRegisterTargets.

Name Type Required Description
ListenerId String Yes Listener ID
Port Integer Yes Binding port
InstanceId String No CVM instance ID
EniIp String No ENI IP
Weight Integer No Weight of a CVM instance. Value range: [0, 100]. If it is not specified when binding the instance, 10 will be used by default.
LocationId String No Layer-7 rule ID

BlockedIP

IP added to blacklist 12306

Used by actions: DescribeBlockIPList.

Name Type Description
IP String Blacklisted IP
CreateTime String Blacklisted time
ExpireTime String Expiration time

CertIdRelatedWithLoadBalancers

Certificate ID and list of CLB instances associated with it

Used by actions: DescribeLoadBalancerListByCertId.

Name Type Description
CertId String Certificate ID
LoadBalancers Array of LoadBalancer List of CLB instances associated with certificate
Note: this field may return null, indicating that no valid values can be obtained.

CertificateInput

Certificate information

Used by actions: CreateListener、CreateRule、ModifyDomainAttributes、ModifyListener、ReplaceCertForLoadBalancers.

Name Type Required Description
SSLMode String No Authentication type. Value range: UNIDIRECTIONAL (unidirectional authentication), MUTUAL (mutual authentication)
CertId String No ID of a server certificate. If you leave this parameter empty, you must upload the certificate, including CertContent, CertKey, and CertName.
CertCaId String No ID of a client certificate. When the listener adopts mutual authentication (i.e., SSLMode = mutual), if you leave this parameter empty, you must upload the client certificate, including CertCaContent and CertCaName.
CertName String No Name of the uploaded server certificate. If there is no CertId, this parameter is required.
CertKey String No Key of the uploaded server certificate. If there is no CertId, this parameter is required.
CertContent String No Content of the uploaded server certificate. If there is no CertId, this parameter is required.
CertCaName String No Name of the uploaded client CA certificate. When SSLMode = mutual, if there is no CertCaId, this parameter is required.
CertCaContent String No Content of the uploaded client certificate. When SSLMode = mutual, if there is no CertCaId, this parameter is required.

CertificateOutput

Certificate information

Used by actions: DescribeListeners、DescribeRewrite.

Name Type Description
SSLMode String Authentication type. Value range: UNIDIRECTIONAL (unidirectional authentication), MUTUAL (mutual authentication)
CertId String Server certificate ID.
CertCaId String Client certificate ID.
Note: This field may return null, indicating that no valid values can be obtained.

ClassicalHealth

Real server health status of a classic CLB

Used by actions: DescribeClassicalLBHealthStatus.

Name Type Description
IP String Private IP of a real server
Port Integer Real server port
ListenerPort Integer CLB listener port
Protocol String Forwarding protocol
HealthStatus Integer Health check result. Value range: 1 (healthy), 0 (unhealthy)

ClassicalListener

Classic CLB listener information

Used by actions: DescribeClassicalLBListeners.

Name Type Description
ListenerId String CLB listener ID
ListenerPort Integer CLB listener port
InstancePort Integer Backend forwarding port of a listener
ListenerName String Listener name
Protocol String Listener protocol type
SessionExpire Integer Session persistence time
HealthSwitch Integer Whether health check is enabled. 1: enabled; 0: disabled.
TimeOut Integer Response timeout period
IntervalTime Integer Check interval
HealthNum Integer Health threshold
UnhealthNum Integer Unhealthy threshold
HttpHash String A request balancing method for HTTP and HTTPS listeners of a public network classic CLB. wrr means weighted round robin, while ip_hash means consistent hashing based on source IPs of access requests.
HttpCode Integer Health check return code for HTTP and HTTPS listeners of a public network classic CLB. For more information, see the explanation of the field in the listener creating API.
HttpCheckPath String Health check path for HTTP and HTTPS listeners of a public network classic CLB
SSLMode String Authentication method for an HTTPS listener of a public network classic CLB
CertId String Server certificate ID for an HTTPS listener of a public network classic CLB
CertCaId String Client certificate ID for an HTTPS listener of a public network classic CLB
Status Integer Listener status. Value range: 0 (creating), 1 (running)

ClassicalLoadBalancerInfo

CLB information

Used by actions: DescribeClassicalLBByInstanceId.

Name Type Description
InstanceId String Real server ID
LoadBalancerIds Array of String List of CLB instance IDs
Note: This field may return null, indicating that no valid values can be obtained.

ClassicalTarget

Real server information of a classic CLB

Used by actions: DescribeClassicalLBTargets.

Name Type Description
Type String Real server type. Value range: CVM, ENI (coming soon)
InstanceId String Unique ID of a real server, which can be obtained from the unInstanceId field in the return of the DescribeInstances API
Weight Integer Forwarding weight of a real server. Value range: [0, 100]. Default value: 10.
PublicIpAddresses Array of String Public IP of a real server
Note: This field may return null, indicating that no valid values can be obtained.
PrivateIpAddresses Array of String Private IP of a real server
Note: This field may return null, indicating that no valid values can be obtained.
InstanceName String Real server instance names
Note: This field may return null, indicating that no valid values can be obtained.
RunFlag Integer Real server status
1: failed; 2: running; 3: creating; 4: shut down; 5: returned; 6: returning; 7: restarting; 8: starting; 9: shutting down; 10: resetting password; 11: formatting; 12: making image; 13: setting bandwidth; 14: reinstalling system; 19: upgrading; 21: hot migrating
Note: This field may return null, indicating that no valid values can be obtained.

ClassicalTargetInfo

Backend information of a classic CLB

Used by actions: RegisterTargetsWithClassicalLB.

Name Type Required Description
InstanceId String Yes Real server ID
Weight Integer No Weight. Value range: [0, 100]

ClusterItem

Dedicated cluster information

Used by actions: DescribeLoadBalancerListByCertId、DescribeLoadBalancers.

Name Type Required Description
ClusterId String Yes Unique cluster ID
ClusterName String No Cluster name
Note: this field may return null, indicating that no valid values can be obtained.
Zone String No Cluster AZ, such as ap-guangzhou-1
Note: this field may return null, indicating that no valid values can be obtained.

ExclusiveCluster

Dedicated cluster

Used by actions: DescribeLoadBalancerListByCertId、DescribeLoadBalancers.

Name Type Required Description
L4Clusters Array of ClusterItem No Layer-4 dedicated cluster list
Note: this field may return null, indicating that no valid values can be obtained.
L7Clusters Array of ClusterItem No Layer-7 dedicated cluster list
Note: this field may return null, indicating that no valid values can be obtained.
ClassicalCluster ClusterItem No vpcgw cluster
Note: this field may return null, indicating that no valid values can be obtained.

ExtraInfo

Reserved field which can be ignored generally.

Used by actions: DescribeLoadBalancerListByCertId、DescribeLoadBalancers.

Name Type Description
ZhiTong Boolean Whether to enable VIP direct connection
Note: This field may return null, indicating that no valid values can be obtained.
TgwGroupName String TgwGroup name
Note: This field may return null, indicating that no valid values can be obtained.

Filter

Filter

Used by actions: DescribeLoadBalancers、DescribeTargetGroupInstances、DescribeTargetGroupList、DescribeTargetGroups.

Name Type Required Description
Name String Yes Filter name
Values Array of String Yes Filter value array

HealthCheck

Health check information.
Note: Custom check parameters are currently supported only in certain beta test regions.

Used by actions: CreateListener、CreateRule、DescribeListeners、DescribeRewrite、ModifyListener、ModifyRule.

Name Type Required Description
HealthSwitch Integer No Whether to enable health check. 1: enable; 0: disable.
TimeOut Integer No Health check response timeout period in seconds (applicable only to layer-4 listeners). Value range: 2-60. Default value: 2. This parameter should be less than the check interval.
Note: This field may return null, indicating that no valid values can be obtained.
IntervalTime Integer No Health check interval in seconds. Value range: 5-300. Default value: 5.
Note: This field may return null, indicating that no valid values can be obtained.
HealthNum Integer No Health threshold. Default value: 3, indicating that if a forward is found healthy three consecutive times, it is considered to be normal. Value range: 2-10
Note: This field may return null, indicating that no valid values can be obtained.
UnHealthNum Integer No Unhealthy threshold. Default value: 3, indicating that if a forward is found unhealthy three consecutive times, it is considered to be exceptional. Value range: 2-10
Note: This field may return null, indicating that no valid values can be obtained.
HttpCode Integer No Health check status code (applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners). Value range: 1-31. Default value: 31.
1 means that the return value of 1xx after detection means healthy, 2 for returning 2xx for healthy, 4 for returning 3xx for healthy, 8 for returning 4xx for healthy, and 16 for returning 5xx for healthy. If you want multiple return codes to represent healthy, sum up the corresponding values. Note: The HTTP health check mode of TCP listeners only supports specifying one kind of health check status code.
Note: This field may return null, indicating that no valid values can be obtained.
HttpCheckPath String No Health check path (applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners).
Note: This field may return null, indicating that no valid values can be obtained.
HttpCheckDomain String No Health check domain name (applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners).
Note: This field may return null, indicating that no valid values can be obtained.
HttpCheckMethod String No Health check method (applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners). Value range: HEAD, GET. Default value: HEAD.
Note: This field may return null, indicating that no valid values can be obtained.
CheckPort Integer No Health check port (a custom check parameter), which is the port of the real server by default. Unless you want to specify a port, it is recommended to leave it empty. (Applicable only to TCP/UDP listeners.)
Note: This field may return null, indicating that no valid values can be obtained.
ContextType String No Health check protocol (a custom check parameter), which is required if the value of CheckType is CUSTOM. This parameter represents the input format of the health check. Value range: HEX, TEXT. If the value is HEX, the characters of SendContext and RecvContext can only be selected from 0123456789ABCDEF and the length must be an even number. (Applicable only to TCP/UDP listeners.)
Note: This field may return null, indicating that no valid values can be obtained.
SendContext String No Health check protocol (a custom check parameter), which is required if the value of CheckType is CUSTOM. This parameter represents the content of the request sent by the health check. Only ASCII visible characters are allowed, and the maximum length is 500. (Applicable only to TCP/UDP listeners.)
Note: This field may return null, indicating that no valid values can be obtained.
RecvContext String No Health check protocol (a custom check parameter), which is required if the value of CheckType is CUSTOM. This parameter represents the result returned by the health check. Only ASCII visible characters are allowed, and the maximum length is 500. (Applicable only to TCP/UDP listeners.)
Note: This field may return null, indicating that no valid values can be obtained.
CheckType String No Health check protocol (a custom check parameter). Value range: TCP, HTTP, CUSTOM (applicable only to TCP/UDP listeners, where UDP listeners only support CUSTOM. If custom health check is used, this parameter is required).
Note: This field may return null, indicating that no valid values can be obtained.
HttpVersion String No Health check protocol (a custom check parameter), which is required if the value of CheckType is HTTP. This parameter represents the HTTP version of the real server. Value range: HTTP/1.0, HTTP/1.1. (Applicable only to TCP listeners.)
Note: This field may return null, indicating that no valid values can be obtained.

InternetAccessible

Network billing mode based on maximum outbound bandwidth

Used by actions: CreateLoadBalancer、DescribeLoadBalancerListByCertId、DescribeLoadBalancers、ModifyLoadBalancerAttributes.

Name Type Required Description
InternetChargeType String No TRAFFIC_POSTPAID_BY_HOUR: hourly pay-as-you-go by traffic; BANDWIDTH_POSTPAID_BY_HOUR: hourly pay-as-you-go by bandwidth;
BANDWIDTH_PACKAGE: billed by bandwidth package (currently, this method is supported only if the ISP is specified)
InternetMaxBandwidthOut Integer No Maximum outbound bandwidth in Mbps, which applies only to public network CLB. Value range: 0-65,535. Default value: 10.
BandwidthpkgSubType String No Bandwidth package type, such as SINGLEISP
Note: This field may return null, indicating that no valid values can be obtained.

LBChargePrepaid

Monthly subscription configuration of a CLB instance

Used by actions: DescribeLoadBalancerListByCertId、DescribeLoadBalancers.

Name Type Required Description
RenewFlag String No Renewal type. AUTO_RENEW: automatic renewal; MANUAL_RENEW: manual renewal
Note: This field may return null, indicating that no valid values can be obtained.
Period Integer No Cycle, indicating the number of months (reserved field)
Note: This field may return null, indicating that no valid values can be obtained.

Listener

Listener information

Used by actions: DescribeListeners.

Name Type Description
ListenerId String CLB listener ID
Protocol String Listener protocol
Port Integer Listener port
Certificate CertificateOutput Information of certificates bound to the listener
Note: This field may return null, indicating that no valid values can be obtained.
HealthCheck HealthCheck Health check information of the listener
Note: This field may return null, indicating that no valid values can be obtained.
Scheduler String Request scheduling method
Note: This field may return null, indicating that no valid values can be obtained.
SessionExpireTime Integer Session persistence time
Note: This field may return null, indicating that no valid values can be obtained.
SniSwitch Integer Whether to enable the SNI feature (this parameter is only meaningful for HTTPS listeners)
Note: This field may return null, indicating that no valid values can be obtained.
Rules Array of RuleOutput All forwarding rules under a listener (this parameter is meaningful only for HTTP/HTTPS listeners)
Note: This field may return null, indicating that no valid values can be obtained.
ListenerName String Listener name
Note: This field may return null, indicating that no valid values can be obtained.
CreateTime String Listener creation time
Note: This field may return null, indicating that no valid values can be obtained.
EndPort Integer End port of a port range
Note: This field may return null, indicating that no valid values can be obtained.
TargetType String Real server type
Note: This field may return null, indicating that no valid values can be obtained.
TargetGroup BasicTargetGroupInfo Basic information of a bound target group. This field will be returned when a target group is bound to a listener.
Note: This field may return null, indicating that no valid values can be obtained.

ListenerBackend

Details of real servers bound to a listener

Used by actions: DescribeTargets.

Name Type Description
ListenerId String Listener ID
Protocol String Listener protocol
Port Integer Listener port
Rules Array of RuleTargets Information of rules under a listener (applicable only to HTTP/HTTPS listeners)
Note: This field may return null, indicating that no valid values can be obtained.
Targets Array of Backend List of real servers bound to a listener (applicable only to TCP/UDP/TCP_SSL listeners)
Note: This field may return null, indicating that no valid values can be obtained.
EndPort Integer Ending port in port range if port range is supported; 0 if port range is not supported
Note: this field may return null, indicating that no valid values can be obtained.

ListenerHealth

Health check information of the listener

Used by actions: DescribeTargetHealth.

Name Type Description
ListenerId String Listener ID
ListenerName String Listener name
Note: This field may return null, indicating that no valid values can be obtained.
Protocol String Listener protocol
Port Integer Listener port
Rules Array of RuleHealth List of forwarding rules of the listener
Note: This field may return null, indicating that no valid values can be obtained.

LoadBalancer

CLB instance information

Used by actions: DescribeLoadBalancerListByCertId、DescribeLoadBalancers.

Name Type Required Description
LoadBalancerId String No CLB instance ID.
LoadBalancerName String No CLB instance name.
LoadBalancerType String No CLB instance network type:
OPEN: public network; INTERNAL: private network.
Forward Integer No CLB type identifier. Value range: 1 (CLB); 0 (classic CLB).
Domain String No CLB instance domain name. This field is provided only to public network classic CLB instance.
Note: This field may return null, indicating that no valid values can be obtained.
LoadBalancerVips Array of String No List of VIPs of a CLB instance.
Note: This field may return null, indicating that no valid values can be obtained.
Status Integer No CLB instance status, including:
0: creating; 1: running.
Note: This field may return null, indicating that no valid values can be obtained.
CreateTime String No CLB instance creation time.
Note: This field may return null, indicating that no valid values can be obtained.
StatusTime String No Last status change time of a CLB instance.
Note: This field may return null, indicating that no valid values can be obtained.
ProjectId Integer No ID of the project to which a CLB instance belongs. 0: default project.
VpcId String No VPC ID
Note: This field may return null, indicating that no valid values can be obtained.
OpenBgp Integer No Protective CLB identifier. Value range: 1 (protective), 0 (non-protective).
Note: This field may return null, indicating that no valid values can be obtained.
Snat Boolean No SNAT is enabled for all private network classic CLB created before December 2016.
Note: This field may return null, indicating that no valid values can be obtained.
Isolation Integer No 0: not isolated; 1: isolated.
Note: This field may return null, indicating that no valid values can be obtained.
Log String No Log information. Only the public network CLB that have HTTP or HTTPS listeners can generate logs.
Note: This field may return null, indicating that no valid values can be obtained.
SubnetId String No Subnet where a CLB instance resides (meaningful only for private network VPC CLB)
Note: This field may return null, indicating that no valid values can be obtained.
Tags Array of TagInfo No CLB instance tag information
Note: This field may return null, indicating that no valid values can be obtained.
SecureGroups Array of String No Security group of a CLB instance
Note: This field may return null, indicating that no valid values can be obtained.
TargetRegionInfo TargetRegionInfo No Basic information of a backend server bound to a CLB instance
Note: This field may return null, indicating that no valid values can be obtained.
AnycastZone String No Anycast CLB publishing region. For non-anycast CLB, this field returns an empty string.
Note: This field may return null, indicating that no valid values can be obtained.
AddressIPVersion String No IP version. Valid values: ipv4, ipv6
Note: this field may return null, indicating that no valid values can be obtained.
NumericalVpcId Integer No VPC ID in a numeric form
Note: This field may return null, indicating that no valid values can be obtained.
VipIsp String No ISP to which a CLB IP address belongs
Note: This field may return null, indicating that no valid values can be obtained.
MasterZone ZoneInfo No Primary AZ
Note: This field may return null, indicating that no valid values can be obtained.
BackupZoneSet Array of ZoneInfo No Secondary AZ
Note: This field may return null, indicating that no valid values can be obtained.
IsolatedTime String No CLB instance isolation time
Note: This field may return null, indicating that no valid values can be obtained.
ExpireTime String No CLB instance expiration time, which takes effect only for prepaid instances
Note: This field may return null, indicating that no valid values can be obtained.
ChargeType String No CLB instance billing mode
Note: This field may return null, indicating that no valid values can be obtained.
NetworkAttributes InternetAccessible No CLB instance network attributes
Note: This field may return null, indicating that no valid values can be obtained.
PrepaidAttributes LBChargePrepaid No Prepaid billing attributes of a CLB instance
Note: This field may return null, indicating that no valid values can be obtained.
LogSetId String No Logset ID of CLB Log Service (CLS)
Note: This field may return null, indicating that no valid values can be obtained.
LogTopicId String No Log topic ID of CLB Log Service (CLS)
Note: This field may return null, indicating that no valid values can be obtained.
AddressIPv6 String No IPv6 address of a CLB instance
Note: This field may return null, indicating that no valid values can be obtained.
ExtraInfo ExtraInfo No Reserved field which can be ignored generally.
Note: This field may return null, indicating that no valid values can be obtained.
IsDDos Boolean No Whether an Anti-DDoS Pro instance can be bound
Note: This field may return null, indicating that no valid values can be obtained.
ConfigId String No Custom configuration ID at the CLB instance level
Note: This field may return null, indicating that no valid values can be obtained.
LoadBalancerPassToTarget Boolean No Whether a real server opens the traffic from a CLB instance to the internet
Note: this field may return null, indicating that no valid values can be obtained.
ExclusiveCluster ExclusiveCluster No Private network dedicated cluster
Note: this field may return null, indicating that no valid values can be obtained.
IPv6Mode String No This field is meaningful only when the IP address version is ipv6. Valid values: IPv6Nat64, IPv6FullChain
Note: this field may return null, indicating that no valid values can be obtained.
SnatPro Boolean No Whether to enable SnatPro
Note: this field may return null, indicating that no valid values can be obtained.
SnatIps Array of SnatIp No SnatIp list after SnatPro load balancing is enabled
Note: this field may return null, indicating that no valid values can be obtained.
SlaType String No Performance guarantee specification
Note: this field may return null, indicating that no valid values can be obtained.
IsBlock Boolean No Whether VIP is blocked
Note: this field may return null, indicating that no valid values can be obtained.
IsBlockTime String No Time blocked or unblocked
Note: this field may return null, indicating that no valid values can be obtained.
LocalBgp Boolean No Whether the IP type is the local BGP
Note: this field may return null, indicating that no valid values can be obtained

LoadBalancerHealth

CLB instance health check status

Used by actions: DescribeTargetHealth.

Name Type Description
LoadBalancerId String CLB instance ID
LoadBalancerName String CLB instance name
Note: This field may return null, indicating that no valid values can be obtained.
Listeners Array of ListenerHealth List of listeners
Note: This field may return null, indicating that no valid values can be obtained.

RewriteLocationMap

Redirection relationship between forwarding rules

Used by actions: DeleteRewrite、ManualRewrite.

Name Type Required Description
SourceLocationId String Yes Source forwarding rule ID
TargetLocationId String Yes Forwarding rule ID of a redirect target

RewriteTarget

Redirect target information

Used by actions: DescribeListeners、DescribeRewrite.

Name Type Description
TargetListenerId String Listener ID of a redirect target
Note: This field may return null, indicating that there is no redirection.
Note: This field may return null, indicating that no valid values can be obtained.
TargetLocationId String Forwarding rule ID of a redirect target
Note: This field may return null, indicating that there is no redirection.
Note: This field may return null, indicating that no valid values can be obtained.

RsWeightRule

Modifies the data type of a node weight

Used by actions: BatchModifyTargetWeight.

Name Type Required Description
ListenerId String Yes CLB listener ID
Targets Array of Target Yes List of real servers for which to modify the weight
LocationId String No Forwarding rule ID
Domain String No Target rule domain name. This parameter does not take effect if LocationId is specified
Url String No Target rule URL. This parameter does not take effect if LocationId is specified
Weight Integer No New forwarding weight of a real server. Value range: 0-100.

RuleHealth

Health check status of a forwarding rule

Used by actions: DescribeTargetHealth.

Name Type Description
LocationId String Forwarding rule ID
Domain String Domain name of the forwarding rule
Note: This field may return null, indicating that no valid values can be obtained.
Url String Forwarding rule Url
Note: This field may return null, indicating that no valid values can be obtained.
Targets Array of TargetHealth Health check status of the real server bound to this rule
Note: This field may return null, indicating that no valid values can be obtained.

RuleInput

HTTP/HTTPS forwarding rule (input)

Used by actions: CreateRule.

Name Type Required Description
Domain String Yes Domain name of the forwarding rule. Length: 1-80.
Url String Yes Forwarding rule path. Length: 1-200.
SessionExpireTime Integer No Session persistence time in seconds. Value range: 30-3,600. Setting it to 0 indicates that session persistence is disabled.
HealthCheck HealthCheck No Health check information
Certificate CertificateInput No Certificate information
Scheduler String No Request forwarding method of the rule. Value range: WRR, LEAST_CONN, IP_HASH
They represent weighted round robin, least connections, and IP hash, respectively. Default value: WRR.
ForwardType String No Forwarding protocol between the CLB instance and real server. Currently, HTTP/HTTPS/TRPC are supported.
DefaultServer Boolean No Whether to set this domain name as the default domain name. Note: Only one default domain name can be set under one listener.
Http2 Boolean No Whether to enable HTTP/2. Note: HTTP/2 can be enabled only for HTTPS domain names.
TargetType String No Target real server type. NODE: binding a general node; TARGETGROUP: binding a target group.
TrpcCallee String No TRPC callee server route, which is required when ForwardType is TRPC.
TrpcFunc String No TRPC calling service API, which is required when ForwardType is TRPC.
Quic Boolean No Whether to enable QUIC. Note: QUIC can be enabled only for HTTPS domain names

RuleOutput

HTTP/HTTPS listener forwarding rule (output)

Used by actions: DescribeListeners、DescribeRewrite.

Name Type Description
LocationId String Forwarding rule ID
Domain String Domain name of the forwarding rule.
Note: This field may return null, indicating that no valid values can be obtained.
Url String Forwarding rule path.
Note: This field may return null, indicating that no valid values can be obtained.
SessionExpireTime Integer Session persistence time
HealthCheck HealthCheck Health check information
Note: This field may return null, indicating that no valid values can be obtained.
Certificate CertificateOutput Certificate information
Note: This field may return null, indicating that no valid values can be obtained.
Scheduler String Request forwarding method of the rule
ListenerId String ID of the listener to which the forwarding rule belongs
RewriteTarget RewriteTarget Redirect target information of a forwarding rule
Note: This field may return null, indicating that no valid values can be obtained.
HttpGzip Boolean Whether to enable gzip
BeAutoCreated Boolean Whether the forwarding rule is automatically created
DefaultServer Boolean Whether to use as the default domain name
Http2 Boolean Whether to enable Http2
ForwardType String Forwarding protocol between CLB and real server
CreateTime String Forwarding rule creation time
TargetType String Real server type
TargetGroup BasicTargetGroupInfo Basic information of a bound target group. This field will be returned if a target group is bound to a rule.
Note: This field may return null, indicating that no valid values can be obtained.
WafDomainId String WAF instance ID
Note: This field may return null, indicating that no valid values can be obtained.
TrpcCallee String TRPC callee server route, which is valid when ForwardType is TRPC.
Note: this field may return null, indicating that no valid values can be obtained.
TrpcFunc String TRPC calling service API, which is valid when ForwardType is TRPC.
Note: this field may return null, indicating that no valid values can be obtained.
QuicStatus String QUIC status
Note: this field may return null, indicating that no valid values can be obtained.

RuleTargets

Information of the real server bound to a forwarding rule under an HTTP/HTTPS listener

Used by actions: DescribeTargets.

Name Type Description
LocationId String Forwarding rule ID
Domain String Domain name of the forwarding rule
Url String Forwarding rule path.
Targets Array of Backend Real server information
Note: This field may return null, indicating that no valid values can be obtained.

SnatIp

SnatIp information structure

Used by actions: CreateLoadBalancerSnatIps、DescribeLoadBalancerListByCertId、DescribeLoadBalancers.

Name Type Required Description
SubnetId String Yes Unique VPC subnet ID, such as subnet-12345678.
Ip String No IP address, such as 192.168.0.1

TagInfo

CLB tag information

Used by actions: CreateLoadBalancer、DescribeLoadBalancerListByCertId、DescribeLoadBalancers.

Name Type Description
TagKey String Tag key
TagValue String Tag value

Target

Redirect target, i.e., the real server bound to a CLB

Used by actions: BatchModifyTargetWeight、DeregisterTargets、ModifyTargetPort、ModifyTargetWeight、RegisterTargets.

Name Type Required Description
Port Integer Yes Listening port of a real server
Note: This field may return null, indicating that no valid values can be obtained.
Type String No Real server type. Value range: CVM (Cloud Virtual Machine), ENI (Elastic Network Interface). This parameter does not take effect currently as an input parameter.
Note: This field may return null, indicating that no valid values can be obtained.
InstanceId String No Unique ID of a CVM instance, which needs to be passed in when binding a CVM instance and can be obtained from the InstanceId field in the return of the DescribeInstances API.
Note: Either InstanceId or EniIp must be passed in.
Note: This field may return null, indicating that no valid values can be obtained.
Weight Integer No Forwarding weight of a real server. Value range: [0, 100]. Default value: 10.
EniIp String No This parameter must be passed in when you bind an ENI, which represents the IP address of the ENI. The ENI has to be bound to a CVM instance first before it can be bound to a CLB instance. Note: Either InstanceId or EniIp must be passed in. To bind an ENI, you need to submit a ticket for application first.
Note: This field may return null, indicating that no valid values can be obtained.

TargetGroupAssociation

Association between rule and target group

Used by actions: AssociateTargetGroups、DisassociateTargetGroups.

Name Type Required Description
LoadBalancerId String Yes CLB instance ID
ListenerId String Yes Listener ID
TargetGroupId String Yes Target group ID
LocationId String No Forwarding rule ID

TargetGroupBackend

Real server bound to a target group

Used by actions: DescribeTargetGroupInstances.

Name Type Description
TargetGroupId String Target group ID
Type String Real server type. Valid values: CVM, ENI (coming soon)
InstanceId String Unique real server ID
Port Integer Listening port of real server
Weight Integer Forwarding weight of real server. Value range: [0, 100]. Default value: 10.
PublicIpAddresses Array of String Public IP of real server
Note: this field may return null, indicating that no valid values can be obtained.
PrivateIpAddresses Array of String Private IP of real server
Note: this field may return null, indicating that no valid values can be obtained.
InstanceName String Real server instance name
Note: this field may return null, indicating that no valid values can be obtained.
RegisteredTime Timestamp Real server binding time
Note: this field may return null, indicating that no valid values can be obtained.
EniId String Unique ENI ID
Note: this field may return null, indicating that no valid values can be obtained.

TargetGroupInfo

Target group information

Used by actions: DescribeTargetGroupList、DescribeTargetGroups.

Name Type Description
TargetGroupId String Target group ID
VpcId String vpcid of target group
TargetGroupName String Target group name
Port Integer Default port of target group
Note: this field may return null, indicating that no valid values can be obtained.
CreatedTime Timestamp Target group creation time
UpdatedTime Timestamp Target group modification time
AssociatedRule Array of AssociationItem Array of associated rules
Note: this field may return null, indicating that no valid values can be obtained.

TargetGroupInstance

Target group instance

Used by actions: CreateTargetGroup、DeregisterTargetGroupInstances、ModifyTargetGroupInstancesPort、ModifyTargetGroupInstancesWeight、RegisterTargetGroupInstances.

Name Type Required Description
BindIP String Yes Private IP of target group instance
Port Integer Yes Port of target group instance
Weight Integer No Weight of target group instance
NewPort Integer No New port of target group instance

TargetHealth

Describes the health information of a target

Used by actions: DescribeTargetHealth.

Name Type Description
IP String Private IP of the target
Port Integer Port bound to the target
HealthStatus Boolean Current health status. true: healthy; false: unhealthy.
TargetId String Instance ID of the target, such as ins-12345678
HealthStatusDetial String Detailed information of the current health status. Alive: healthy; Dead: exceptional; Unknown: check not started/checking/unknown status.

TargetRegionInfo

Information of the real server bound to a CLB instance, including region and network to which it belongs.

Used by actions: DescribeLoadBalancerListByCertId、DescribeLoadBalancers、ModifyLoadBalancerAttributes.

Name Type Required Description
Region String Yes Region of the target, such as ap-guangzhou
VpcId String Yes Network of the target, which is in the format of vpc-abcd1234 for VPC or 0 for basic network

ZoneInfo

AZ information

Used by actions: DescribeLoadBalancerListByCertId、DescribeLoadBalancers.

Name Type Description
ZoneId Integer Unique AZ ID in a numeric form, such as 100001
Note: This field may return null, indicating that no valid values can be obtained.
Zone String Unique AZ ID in a string form, such as ap-guangzhou-1
Note: This field may return null, indicating that no valid values can be obtained.
ZoneName String AZ name, such as Guangzhou Zone 1
Note: This field may return null, indicating that no valid values can be obtained.

Was this page helpful?

Confirm

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Hide
Submit a TicketContact Sales
Help
tencent
Copyright © 2013-2020 Tencent Cloud. All Rights Reserved.
Terms of ServicePrivacy PolicyCookie Policy