Data Types

Last updated: 2021-04-07 19:47:29

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. Valid values: CVM, ENI.
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. Indicating binding the primary IP of the primary ENI.
EniIp String No ENI IP or other private IP. This parameter is required for binding a dual-stack IPv6 CVM instance.
Weight Integer No CVM instance weight. 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 blocklist 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: CreateLoadBalancer, 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: CreateLoadBalancer, 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, DescribeLoadBalancersDetail.

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, DescribeLoadBalancersDetail, 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, DescribeLoadBalancersDetail, 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, DescribeLoadBalancersDetail.

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