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 |
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. |
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 |
Batch binding type
Used by actions: BatchDeregisterTargets, BatchRegisterTargets.
Name | Type | Required | Description |
---|---|---|---|
ListenerId | String | Yes | Listener ID. |
Port | Integer | Yes | The port to Bind |
InstanceId | String | No | CVM instance ID. The primary IP of the primary ENI will be bound. |
EniIp | String | No | It is required for binding an IP. It supports an ENI IP or any other private IP. To bind an ENI IP, the ENI should be bound to a CVM instance before being bound to a CLB instance. Note: either InstanceId or EniIp must be passed in, which is required for binding a dual-stack IPv6 CVM instance. |
Weight | Integer | No | Weight of the CVM instance. Value range: [0, 100]. If it is not specified for binding the instance, 10 will be used by default. |
LocationId | String | No | Layer-7 rule ID. |
Binding details including listener name, protocol, url and vport
Used by actions: DescribeCustomizedConfigAssociateList.
Name | Type | Description |
---|---|---|
LoadBalancerId | String | Specifies the ID of CLB to be bound |
ListenerId | String | Specifies the ID of listener to be bound Note: this field may return null , indicating that no valid values can be obtained. |
Domain | String | Specifies the domain name to be bound Note: this field may return null , indicating that no valid values can be obtained. |
LocationId | String | Sets the bound rule. 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. |
Protocol | String | Listener protocol. Note: this field may return null , indicating that no valid values can be obtained. |
Vport | Integer | Listener port. Note: this field may return null , indicating that no valid values can be obtained. |
Url | String | URL of the location. Note: this field may return null , indicating that no valid values can be obtained. |
UconfigId | String | Configuration ID. Note: this field may return null , indicating that no valid values can be obtained. |
IP added to blocklist 12306
Used by actions: DescribeBlockIPList.
Name | Type | Description |
---|---|---|
IP | String | Blacklisted IP |
CreateTime | String | Blacklisted time |
ExpireTime | String | Expiration time |
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. |
Certificate information
Used by actions: CreateListener, ModifyDomainAttributes, ModifyListener.
Name | Type | Required | Description |
---|---|---|---|
CertId | String | No | ID of the certificate. If it's not specified, CertContent and CertKey are required. For a server certificate, you also need to specify CertName . |
CertName | String | No | Name of the uploaded certificate. It's required if CertId is not specified. |
CertContent | String | No | Public key of the uploaded certificate. This is required if CertId is not specified. |
CertKey | String | No | Private key of the uploaded server certificate. This is required if CertId is not specified. |
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. |
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. |
ExtCertIds | Array of String | IDs of extra server certificates Note: This field may return null , indicating that no valid values can be obtained. |
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) |
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) |
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. |
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. |
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] |
Dedicated cluster information
Used by actions: CloneLoadBalancer, CreateLoadBalancer, MigrateClassicalLoadBalancers.
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. |
Configuration content
Used by actions: DescribeCustomizedConfigList.
Name | Type | Description |
---|---|---|
UconfigId | String | Configuration ID. |
ConfigType | String | Configuration type. |
ConfigName | String | Configuration name. Note: this field may return null , indicating that no valid values can be obtained. |
ConfigContent | String | Configuration content. |
CreateTimestamp | String | Creates configuration time. |
UpdateTimestamp | String | Modifies configuration time. |
Information of CVMs and ENIs that use cross-region binding 2.0
Used by actions: DescribeCrossTargets.
Name | Type | Description |
---|---|---|
LocalVpcId | String | VPC ID of the CLB instance |
VpcId | String | VPC ID of the CVM or ENI instance |
IP | String | IP address of the CVM or ENI instance |
VpcName | String | VPC name of the CVM or ENI instance |
EniId | String | ENI ID of the CVM instance |
InstanceId | String | ID of the CVM instance Note: This field may return null , indicating that no valid value was found. |
InstanceName | String | Name of the CVM instance Note: This field may return null , indicating that no valid value was found. |
Region | String | Region of the CVM or ENI instance |
Dedicated cluster
Used by actions: CloneLoadBalancer, CreateLoadBalancer, DescribeLoadBalancerListByCertId, DescribeLoadBalancers, MigrateClassicalLoadBalancers.
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. |
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
Used by actions: DescribeCrossTargets, DescribeCustomizedConfigList, DescribeLoadBalancers, DescribeLoadBalancersDetail, DescribeResources, DescribeTargetGroupInstances, DescribeTargetGroupList, DescribeTargetGroups, DescribeTargets.
Name | Type | Required | Description |
---|---|---|---|
Name | String | Yes | Filter name |
Values | Array of String | Yes | Filter value array |
SCF related information
Used by actions: DeregisterFunctionTargets, ModifyFunctionTargets, RegisterFunctionTargets.
Name | Type | Required | Description |
---|---|---|---|
FunctionNamespace | String | Yes | Function namespace |
FunctionName | String | Yes | Function name |
FunctionQualifier | String | Yes | Function version name or alias |
FunctionQualifierType | String | No | Function qualifier type. Values: VERSION , ALIAS .Note: This field may return null , indicating that no valid values can be obtained. |
Whether to use SCF (Serverless Cloud Function) as the backend service
Used by actions: DeregisterFunctionTargets, DescribeTargets, ModifyFunctionTargets, RegisterFunctionTargets.
Name | Type | Required | Description |
---|---|---|---|
Function | FunctionInfo | Yes | SCF related information Note: This field may return null , indicating that no valid values can be obtained. |
Weight | Integer | No | Weight |
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 probing interval period. It defaults to 5 . For IPv4 CLB instances, the range is 2-300. For IPv6 CLB instances, the range is 5-300. Unit: secondNote: For some IPv4 CLB instances created long ago, the range is 5-300. 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 : Returns code 1xx for healthy status. 2 : Returns code 2xx for healthy status. 4 : Returns code 3xx for healthy status. 8 : Returns code 4xx for healthy status. 16 : Returns code 5xx for healthy status. If you want multiple return codes to represent healthy, sum up the corresponding values. 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. It's applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners. It's required for HTTP health check 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. Values: TCP , HTTP , HTTPS , GRPC , PING , and CUSTOM . UDP listeners support PING /CUSTOM . TCP listener support TCP /HTTP /CUSTOM . TCP_SSL and QUIC listeners support TCP /HTTP . HTTP rules support HTTP /GRPC. HTTPS rules support HTTP/ HTTPS/ GRPC`.Note: This field may return null, indicating that no valid values can be obtained. |
HttpVersion | String | No | HTTP version. HTTP version of the backend service. Values: HTTP/1.0 , HTTP/1.1. It is only applicable to TCP listeners, and is required when CheckType= HTTP`. Note: This field may return null, indicating that no valid values can be obtained. |
SourceIpType | Integer | No | Specifies the type of health check source IP. 0 (default): CLB VIP. 1 : 100.64 IP range.Note: This field may return null, indicating that no valid values can be obtained. |
ExtendedCode | String | No | GRPC health check status code, which is only applicable to rules with GRPC as the backend forwarding protocol. It can be a single number (such as 20 ), multiple numbers (such as 20,25 ) or a range (such as 0-99 ). The default value is 12 .Note: This field may return null , indicating that no valid values can be obtained. |
ID of the idle CLB instance
Used by actions: DescribeIdleLoadBalancers.
Name | Type | Description |
---|---|---|
LoadBalancerId | String | CLB instance ID |
LoadBalancerName | String | CLB instance name |
Region | String | CLB instance region |
Vip | String | CLB instance VIP |
IdleReason | String | The reason why the load balancer is considered idle. NO_RULES : No rules configured. NO_RS : The rules are not associated with servers. |
Status | Integer | CLB instance status, including:0 : Creating; 1 : Running. |
Forward | Integer | CLB type. Value range: 1 (CLB); 0 (classic CLB). |
Domain | String | The load balancing hostname. Note: This field may return null , indicating that no valid values can be obtained. |
Network billing mode based on maximum outbound bandwidth
Used by actions: CloneLoadBalancer, CreateLoadBalancer, DescribeLoadBalancerListByCertId, DescribeLoadBalancers, DescribeLoadBalancersDetail, InquiryPriceCreateLoadBalancer, InquiryPriceModifyLoadBalancer, 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 outgoing bandwidth in Mbps. It works on LCU-supported instances on private networks and all instances on public networks. - For shared and dedicated CLB instances on public networks, the range is 1Mbps-2048Mbps. - For all LCU-supported CLB instances: - It defaults to General LCU-supported instance. SLA corresponds to Super Large 1, and the range of maximum outgoing bandwidth is 1 Mbps - 10240 Mbps. - If you have enabled Super Large specification, the range of maximum outgoing bandwidth is 1 Mbps - 61440 Mbps Super Large LCU-supported specification is in beta now. To join the beta, submit a ticket. Note: This field may return null, indicating that no valid values can be obtained. |
BandwidthpkgSubType | String | No | Bandwidth package type, such as SINGLEISP Note: This field may return null, indicating that no valid values can be obtained. |
Pricing information of an item
Used by actions: InquiryPriceCreateLoadBalancer, InquiryPriceModifyLoadBalancer, InquiryPriceRefundLoadBalancer, InquiryPriceRenewLoadBalancer.
Name | Type | Description |
---|---|---|
UnitPrice | Float | PAYG unit price, in USD. Note: This field may return·null, indicating that no valid values can be obtained. |
ChargeUnit | String | Subsequent billing unit. Value Range: HOUR : Calculate the cost by hour. It's available when "InternetChargeType=POSTPAID_BY_HOUR".GB : Calculate the cost by traffic in GB. It's available when "InternetChargeType=TRAFFIC_POSTPAID_BY_HOUR".Note: This field may return·null, indicating that no valid values can be obtained. |
OriginalPrice | Float | Reserved field Note: This field may return·null, indicating that no valid values can be obtained. |
DiscountPrice | Float | Reserved field Note: This field may return·null, indicating that no valid values can be obtained. |
UnitPriceDiscount | Float | Discount unit price of a pay-as-you-go instance, in USD. Note: This field may return·null, indicating that no valid values can be obtained. |
Discount | Float | Discount. For example, 20.0 indicates 80% off. Note: This field may return·null, indicating that no valid values can be obtained. |
Monthly subscription configuration of a CLB instance
Used by actions: DescribeLoadBalancerListByCertId, DescribeLoadBalancers, DescribeLoadBalancersDetail, InquiryPriceCreateLoadBalancer, InquiryPriceRenewLoadBalancer.
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. |
Querying the binding relation of the CLB instance
Used by actions: DescribeLBListeners.
Name | Type | Description |
---|---|---|
LoadBalancerId | String | String ID of the CLB instance. |
Vip | String | VIP of the CLB instance. |
Listeners | Array of ListenerItem | Listener rule. |
Region | String | Region of the CLB instance |
Querying the input data types
Used by actions: DescribeLBListeners.
Name | Type | Required | Description |
---|---|---|---|
VpcId | String | Yes | VPC ID |
PrivateIp | String | Yes | Private network IP to be queried, which can be of the CVM or ENI. |
Querying the output data types
Used by actions: DescribeLBListeners.
Name | Type | Description |
---|---|---|
Type | String | Private network IP type, which can be cvm or eni . |
PrivateIp | String | Private network IP of the real server. |
Port | Integer | Port bound to the real server. |
VpcId | Integer | VPC ID of the real server. Note: this field may return null , indicating that no valid values can be obtained. |
Weight | Integer | Weight of the real server. Note: this field may return null , indicating that no valid values can be obtained. |
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 SNI. 1 : Enable; 0 : Do not enable. 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. |
SessionType | String | Session persistence type. Valid values: Normal: the default session persistence type; QUIC_CID: session persistence by QUIC connection ID. Note: this field may return null, indicating that no valid values can be obtained. |
KeepaliveEnable | Integer | Whether a persistent connection is enabled (1: enabled; 0: disabled). This parameter can only be configured in HTTP/HTTPS listeners. Note: this field may return null , indicating that no valid values can be obtained. |
Toa | Boolean | Only the NAT64 CLB TCP listeners are supported. Note: this field may return null , indicating that no valid values can be obtained. |
DeregisterTargetRst | Boolean | Whether to send the TCP RST packet to the client when unbinding a real server. This parameter is applicable to TCP listeners only. Note: this field may return null , indicating that no valid values can be obtained. |
AttrFlags | Array of String | Attribute of listener Note: This field may return null , indicating that no valid values can be obtained. |
TargetGroupList | Array of BasicTargetGroupInfo | List of bound target groups Note: This field may return null , indicating that no valid values can be obtained. |
MaxConn | Integer | Maximum number of concurrent listener connections. If it’s set to -1 , the listener speed is not limited. Note: This field may return null , indicating that no valid values can be obtained. |
MaxCps | Integer | Maximum number of new listener connections. If it’s set to -1 , the listener speed is not limited. Note: This field may return null , indicating that no valid values can be obtained. |
IdleConnectTimeout | Integer | Connection idle timeout period (in seconds). It’s only available to TCP listeners. Value range: 300-900 for shared and dedicated instances; 300-2000 for LCU-supported CLB instances. It defaults to 900. Note: This field may return null , indicating that no valid values can be obtained. |
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. |
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. |
Querying the listener type
Used by actions: DescribeLBListeners.
Name | Type | Description |
---|---|---|
ListenerId | String | Listener ID. |
Protocol | String | Listener protocol. |
Port | Integer | Listener port. |
Rules | Array of RulesItems | Bound rule. Note: this field may return null , indicating that no valid values can be obtained. |
Targets | Array of LbRsTargets | Object bound to the layer-4 listener. Note: this field may return null , indicating that no valid values can be obtained. |
EndPort | Integer | End port of the listener. Note: this field may return null , indicating that no valid values can be obtained. |
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 | Domain name of the CLB instance. It is only available for public classic CLBs. This parameter will be discontinued soon. Please use LoadBalancerDomain instead.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 | Billing mode of CLB instance. Valid values: PREPAID (monthly subscription), POSTPAID_BY_HOUR (pay as you go). 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, IPv6FullChainNote: 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 | Specification of the LCU-supported instance. 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 |
ClusterTag | String | No | Dedicated layer-7 tag. Note: this field may return null, indicating that no valid values can be obtained. |
MixIpTarget | Boolean | No | If the layer-7 listener of an IPv6FullChain CLB instance is enabled, the CLB instance can be bound with an IPv4 and an IPv6 CVM instance simultaneously. Note: this field may return null, indicating that no valid values can be obtained. |
Zones | Array of String | No | Availability zone of a VPC-based private network CLB instance Note: this field may return null , indicating that no valid values can be obtained. |
NfvInfo | String | No | Whether it is an NFV CLB instance. No returned information: no; l7nfv: yes. Note: this field may return null , indicating that no valid values can be obtained. |
HealthLogSetId | String | No | Health check logset ID of CLB CLS Note: this field may return null , indicating that no valid values can be obtained. |
HealthLogTopicId | String | No | Health check log topic ID of CLB CLS Note: this field may return null , indicating that no valid values can be obtained. |
ClusterIds | Array of String | No | Cluster ID. Note: This field may return null, indicating that no valid values can be obtained. |
AttributeFlags | Array of String | No | CLB attribute Note: this field may return null , indicating that no valid values can be obtained. |
LoadBalancerDomain | String | No | Domain name of the CLB instance. Note: This field may return null, indicating that no valid values can be obtained. |
Egress | String | No | Network egress Note: This field may return·null, indicating that no valid values can be obtained. |
CLB instance details
Used by actions: DescribeLoadBalancersDetail.
Name | Type | Description |
---|---|---|
LoadBalancerId | String | CLB instance ID. |
LoadBalancerName | String | CLB instance name. |
LoadBalancerType | String | CLB instance network type: Public: public network; Private: private network. Note: this field may return null, indicating that no valid values can be obtained. |
Status | Integer | CLB instance status, including: 0: creating; 1: running. Note: this field may return null, indicating that no valid values can be obtained. |
Address | String | CLB instance VIP. Note: this field may return null, indicating that no valid values can be obtained. |
AddressIPv6 | String | IPv6 VIP address of the CLB instance. Note: this field may return null, indicating that no valid values can be obtained. |
AddressIPVersion | String | IP version of the CLB instance. Valid values: IPv4, IPv6. Note: this field may return null, indicating that no valid values can be obtained. |
IPv6Mode | String | IPv6 address type of the CLB instance. Valid values: IPv6Nat64, IPv6FullChain. Note: this field may return null, indicating that no valid values can be obtained. |
Zone | String | Availability zone where the CLB instance resides. Note: this field may return null, indicating that no valid values can be obtained. |
AddressIsp | String | ISP to which the CLB IP address belongs. Note: this field may return null, indicating that no valid values can be obtained. |
VpcId | String | ID of the VPC instance to which the CLB instance belongs. Note: this field may return null, indicating that no valid values can be obtained. |
ProjectId | Integer | ID of the project to which the CLB instance belongs. 0: default project. Note: this field may return null, indicating that no valid values can be obtained. |
CreateTime | String | CLB instance creation time. Note: this field may return null, indicating that no valid values can be obtained. |
ChargeType | String | CLB instance billing mode. Note: this field may return null, indicating that no valid values can be obtained. |
NetworkAttributes | InternetAccessible | CLB instance network attribute. Note: this field may return null, indicating that no valid values can be obtained. |
PrepaidAttributes | LBChargePrepaid | Pay-as-you-go attribute of the CLB instance. Note: this field may return null, indicating that no valid values can be obtained. |
ExtraInfo | ExtraInfo | Reserved field, which can be ignored generally. Note: this field may return null, indicating that no valid values can be obtained. |
ConfigId | String | Custom configuration IDs of CLB instances. Multiple IDs must be separated by commas (,). Note: This field may return null, indicating that no valid values can be obtained. |
Tags | Array of TagInfo | CLB instance tag information. Note: this field may return null, indicating that no valid values can be obtained. |
ListenerId | String | CLB listener ID. Note: this field may return null, indicating that no valid values can be obtained. |
Protocol | String | Listener protocol. Note: this field may return null, indicating that no valid values can be obtained. |
Port | Integer | Listener port. Note: this field may return null, indicating that no valid values can be obtained. |
LocationId | String | Forwarding rule ID. Note: this field may return null, indicating that no valid values can be obtained. |
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. |
TargetId | String | ID of target real servers. Note: this field may return null, indicating that no valid values can be obtained. |
TargetAddress | String | Address of target real servers. Note: this field may return null, indicating that no valid values can be obtained. |
TargetPort | Integer | Listening port of target real servers. Note: this field may return null, indicating that no valid values can be obtained. |
TargetWeight | Integer | Forwarding weight of target real servers. Note: this field may return null, indicating that no valid values can be obtained. |
Isolation | Integer | 0: not isolated; 1: isolated. Note: this field may return null, indicating that no valid values can be obtained. |
SecurityGroup | Array of String | List of the security groups bound to the CLB instance. Note: this field may return null , indicating that no valid values can be obtained. |
LoadBalancerPassToTarget | Integer | Whether the CLB instance is billed by IP. Note: this field may return null , indicating that no valid values can be obtained. |
TargetHealth | String | Health status of the target real server. Note: this field may return null , indicating that no valid values can be obtained. |
Domains | String | List o domain names associated with the forwarding rule Note: This field may return null , indicating that no valid values can be obtained. |
SlaveZone | Array of String | The secondary zone of multi-AZ CLB instance Note: This field may return null , indicating that no valid values can be obtained. |
Zones | Array of String | The AZ of private CLB instance. This is only available for beta users. Note: This field may return null , indicating that no valid values can be obtained. |
SniSwitch | Integer | Whether to enable SNI. 1 : Enable; 0 : Do not enable. This parameter is only meaningful for HTTPS listeners.Note: This field may return·null, indicating that no valid values can be obtained. |
LoadBalancerDomain | String | Domain name of the CLB instance. Note: This field may return null, indicating that no valid values can be obtained. |
Egress | String | Network egress Note: This field may return·null, indicating that no valid values can be obtained. |
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. |
CLB instance traffic data
Used by actions: DescribeLoadBalancerTraffic.
Name | Type | Description |
---|---|---|
LoadBalancerId | String | CLB instance ID |
LoadBalancerName | String | CLB instance name |
Region | String | CLB instance region |
Vip | String | CLB instance VIP |
OutBandwidth | Float | Maximum outbound bandwidth in Mbps |
Domain | String | CLB domain name Note: This field may return null , indicating that no valid values can be obtained. |
Information of multiple certificates bound with the load balancer listener or rule.
Used by actions: CreateListener, CreateRule, ModifyDomainAttributes, ModifyListener.
Name | Type | Required | Description |
---|---|---|---|
SSLMode | String | Yes | Authentication type. Values: UNIDIRECTIONAL (one-way authentication), MUTUAL (two-way authentication) |
CertList | Array of CertInfo | Yes | List of listener or rule certificates. One-way and two-way authentication are supported. Only one certificate can be specified for one algorithm. If SSLMode is MUTUAL (two-way authentication), at least one CA certificate is required. |
Price of CLB instances.
Used by actions: InquiryPriceCreateLoadBalancer, InquiryPriceModifyLoadBalancer, InquiryPriceRefundLoadBalancer, InquiryPriceRenewLoadBalancer.
Name | Type | Description |
---|---|---|
InstancePrice | ItemPrice | Instance price. Note: This field may return·null, indicating that no valid values can be obtained. |
BandwidthPrice | ItemPrice | Network price. Note: This field may return·null, indicating that no valid values can be obtained. |
LcuPrice | ItemPrice | LCU price. Note: This field may return·null, indicating that no valid values can be obtained. |
Quota description. All quotas are in the current region.
Used by actions: DescribeQuota.
Name | Type | Description |
---|---|---|
QuotaId | String | Quota name. Valid values:TOTAL_OPEN_CLB_QUOTA : Quota of public network CLB instances in the current regionTOTAL_INTERNAL_CLB_QUOTA : Quota of private network CLB instances in the current regionTOTAL_LISTENER_QUOTA : Quota of listeners under one CLB instanceTOTAL_LISTENER_RULE_QUOTA : Quota of forwarding rules under one listenerTOTAL_TARGET_BIND_QUOTA : Quota of CVM instances can be bound under one forwarding ruleTOTAL_SNAP_IP_QUOTA : Quota of SNAT IPs for cross-region binding 2.0 under one CLB instance TOTAL_ISP_CLB_QUOTA : Quota of triple-ISP (CMCC/CUCC/CTCC) CLB instances in the current region |
QuotaCurrent | Integer | Currently used quantity. If it is null , it is meaningless.Note: this field may return null, indicating that no valid values can be obtained. |
QuotaLimit | Integer | Quota limit. |
Resource details
Used by actions: DescribeResources.
Name | Type | Description |
---|---|---|
Type | Array of String | Specific ISP resource information, Vaules: CMCC , CUCC , CTCC , BGP , and INTERNAL . |
Isp | String | ISP information, such as CMCC , CUCC , CTCC , BGP , and INTERNAL . |
AvailabilitySet | Array of ResourceAvailability | Available resources Note: This field may return null , indicating that no valid values can be obtained. |
TypeSet | Array of TypeInfo | ISP Type Note: This field may return null, indicating that no valid values can be obtained. |
Resource availability
Used by actions: DescribeResources.
Name | Type | Description |
---|---|---|
Type | String | Specific ISP resource information. Values: CMCC , CUCC , CTCC , BGP . |
Availability | String | Whether the resource is available. Values: Available , Unavailable |
Redirection relationship between forwarding rules
Used by actions: DeleteRewrite, ManualRewrite.
Name | Type | Required | Description |
---|---|---|---|
SourceLocationId | String | Yes | Source forwarding rule ID |
TargetLocationId | String | Yes | ID of the forwarding rule of the destination |
RewriteCode | Integer | No | Redirection status code. Valid values: 301, 302, and 307. |
TakeUrl | Boolean | No | Whether the matched URL is carried in redirection. It is required when configuring RewriteCode . |
SourceDomain | String | No | Original domain name of redirection, which must be the corresponding domain name of SourceLocationId . It is required when configuring RewriteCode . |
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. |
RewriteCode | Integer | Redirection status code Note: this field may return null , indicating that no valid values can be obtained. |
TakeUrl | Boolean | Whether the matched URL is carried in redirection. Note: this field may return null , indicating that no valid values can be obtained. |
RewriteType | String | Redirection type. Manual: manual redirection; Auto: automatic redirection. Note: this field may return null , indicating that no valid values can be obtained. |
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 whose weights to modify. |
LocationId | String | No | Forwarding rule ID, which is required only for layer-7 rules. |
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 | The new forwarding weight of the real server. Value range: [0, 100]. This parameter takes lower precedence than Weight in Targets , which means that this parameter only takes effect when the Weight in RsWeightRule is left empty. |
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 status of the real server bound to this rule Note: this field may return null , indicating that no valid values can be obtained. |
HTTP/HTTPS forwarding rule (input)
Used by actions: CreateRule.
Name | Type | Required | Description |
---|---|---|---|
Url | String | Yes | Forwarding rule path. Length: 1-200. |
Domain | String | No | The domain name associated with the forwarding rule. It can contain 1-80 characters. Only one domain name can be entered. If you need to enter multiple domain names, use Domains . |
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. For more information, please see Health Check |
Certificate | CertificateInput | No | Certificate information. Certificate and MultiCertInfo cannot be specified at the same time. |
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 backend service. Values: HTTP , HTTPS , GRPC and TRPC (only for internal usage). It defaults to HTTP . |
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". This is now only for internal usage. |
TrpcFunc | String | No | TRPC calling service API, which is required when ForwardType is "TRPC". This is now only for internal usage. |
Quic | Boolean | No | Whether to enable QUIC. Note: QUIC can be enabled only for HTTPS domain names |
Domains | Array of String | No | The domain name associated with the forwarding rule. Each contain 1-80 characters. If you only need to enter one domain name, use Domain instead. |
MultiCertInfo | MultiCertInfo | No | Certificate information. You can specify multiple server-side certificates with different algorithm types. Certificate and MultiCertInfo cannot be specified at the same time. |
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 . This is now only for internal usage.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 . This is now only for internal usage.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. |
Domains | Array of String | List of domain names associated with the forwarding rule Note: This field may return null , indicating that no valid values can be obtained. |
TargetGroupList | Array of BasicTargetGroupInfo | List of bound target groups Note: This field may return null , indicating that no valid values can be obtained. |
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. |
FunctionTargets | Array of FunctionTarget | Information about backend SCF functions. Note: This field may return null, indicating that no valid values can be obtained. |
Object bound to the layer-7 listener rule
Used by actions: DescribeLBListeners.
Name | Type | Description |
---|---|---|
LocationId | String | Rule ID. |
Domain | String | Domain name. |
Url | String | Uri |
Targets | Array of LbRsTargets | Object bound to the real server. |
Parameters for upgrading to an LCU-supported instance
Used by actions: ModifyLoadBalancerSla.
Name | Type | Required | Description |
---|---|---|---|
LoadBalancerId | String | Yes | ID of the CLB instance |
SlaType | String | Yes | LCU-supported instance specification. Value:SLA : If you have activated Super Large LCU-supported instances, SLA indicates Super Large 4.clb.c2.medium : Standardclb.c3.small : Advanced 1clb.c3.medium : Advanced 2clb.c4.small : Super Large 1clb.c4.medium : Super Large 2clb.c4.large : Super Large 3clb.c4.xlarge : Super Large 4 |
SnatIp
information structure
Used by actions: CloneLoadBalancer, CreateLoadBalancer, 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 |
Specification availability
Used by actions: DescribeResources.
Name | Type | Description |
---|---|---|
SpecType | String | Specification type Note: This field may return null, indicating that no valid values can be obtained. |
Availability | String | Specification availability Note: This field may return null, indicating that no valid values can be obtained. |
CLB tag information
Used by actions: CloneLoadBalancer, CreateLoadBalancer, DescribeLoadBalancerListByCertId, DescribeLoadBalancers, DescribeLoadBalancersDetail.
Name | Type | Required | Description |
---|---|---|---|
TagKey | String | Yes | Tag key |
TagValue | String | Yes | Tag value |
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 parameter is required when binding a CVM or ENI. 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 is required when binding a CVM instance. It can be obtained from the InstanceId field in the response of the DescribeInstances API. It indicates binding the primary IP of the primary ENI.Note: Either InstanceId or EniIp can be passed in.Note: This field may return null , indicating that no valid values can be obtained. |
Weight | Integer | No | The new forwarding weight of the real server. Value range: [0, 100]. Default: 10. This parameter takes priority over Weight in RsWeightRule . If it’s left empty, the value of Weight in RsWeightRule will be used. |
EniIp | String | No | It is required when binding an IP. ENI IPs and other private IPs are supported. To bind an ENI IP, the ENI should be bound to a CVM instance before being bound to a CLB instance. Note: Either InstanceId or EniIp can be passed in. EniIp is required in a cross-region binding or when the dual-stack IPV6 CVM is bound.Note: This field may return null , indicating that no valid values can be obtained. |
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 |
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. |
ZoneId | Integer | AZ ID of the real server Note: This field may return null , indicating that no valid values can be obtained. |
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. |
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 |
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 |
HealthStatusDetail | String | Detailed information about the current health status. Alive: healthy; Dead: exceptional; Unknown: check not started/checking/unknown status. |
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 |
ISP Type
Used by actions: DescribeResources.
Name | Type | Description |
---|---|---|
Type | String | ISP Type Note: This field may return null, indicating that no valid values can be obtained. |
SpecAvailabilitySet | Array of SpecAvailability | Specification availability Note: This field may return null, indicating that no valid values can be obtained. |
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. |
ZoneRegion | String | AZ region, e.g., ap-guangzhou. Note: This field may return null , indicating that no valid values can be obtained. |
LocalZone | Boolean | Whether the AZ is the LocalZone , e.g., false.Note: This field may return null , indicating that no valid values can be obtained. |
EdgeZone | Boolean | Whether the AZ is an edge zone. Values: true , false .Note: This field may return null , indicating that no valid values can be obtained. |
List of AZs
Used by actions: DescribeResources.
Name | Type | Description |
---|---|---|
MasterZone | String | Primary AZ, such as "ap-guangzhou-1". |
ResourceSet | Array of Resource | List of resources Note: This field may return null, indicating that no valid values can be obtained. |
SlaveZone | String | Secondary AZ, such as "ap-guangzhou-2". Note: This field may return null, indicating that no valid values can be obtained. |
IPVersion | String | IP version. Values: IPv4 , IPv6 , and IPv6_Nat . |
ZoneRegion | String | Region of the AZ, such as ap-guangzhou . |
LocalZone | Boolean | Whether the AZ is a LocalZone . Values: true , false . |
ZoneResourceType | String | Type of resources in the zone. Values: SHARED , EXCLUSIVE |
EdgeZone | Boolean | Whether the AZ is an edge zone. Values: true , false . |
Egress | String | Network egress Note: This field may return·null, indicating that no valid values can be obtained. |
Was this page helpful?