History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
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 |
| Weight | Integer | Weight associated with the target group. this parameter takes effect only for the new version v2 target group. |
| RuleId | String | Advanced routing rule ID. |
Details of a real server bound to a listener
Used by actions: DescribeTargets.
| Name | Type | Description |
|---|---|---|
| Type | String | Specifies the backend service type. valid values: CVM, ENI, CCN, EVM, GLOBALROUTE, NAT, SRV. |
| 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 | Specifies the listening port of the backend service. if it is a full listening target group bound to a port range listener, this port returns 0, indicating an invalid port. the port of the bound backend service follows the listener port. |
| 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 network IP of the real server |
| InstanceName | String | Real server instance names Note: This field may return null, indicating that no valid values can be obtained. |
| RegisteredTime | String | Real server binding time |
| EniId | String | Unique ENI ID Note: This field may return null, indicating that no valid values can be obtained. |
| Tag | String | Tag. |
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 |
| Weight | Integer | Specifies the weight of the target group. |
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. This parameter is required for Layer-7 CLB. |
| Tag | String | No | Tag. |
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 | ID of the listener bound to the configuration |
| Domain | String | Domain name bound to the configuration |
| LocationId | String | Rule bound to the configuration |
| ListenerName | String | Listener name |
| Protocol | String | Listener protocol |
| Vport | Integer | Listener port |
| Url | String | URL of the location. Note: this field may return null, indicating that no valid values can be obtained. |
| UconfigId | String | Configuration ID. |
Configuration binding relationship
Used by actions: AssociateCustomizedConfig, DisassociateCustomizedConfig.
| Name | Type | Required | Description |
|---|---|---|---|
| LoadBalancerId | String | Yes | ID of the CLB instance bound to the configuration |
| ListenerId | String | Yes | ID of the listener bound to the configuration |
| Domain | String | Yes | Domain name bound to the configuration |
| LocationId | String | No | Rule bound to the configuration |
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 the certificate |
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. UNIDIRECTIONAL: one-way authentication; MUTUAL: mutual authentication. Default value: UNIDIRECTIONAL. |
| SSLVerifyClient | String | No | Whether to enable client authentication for mutual authentication. ON: enable it; OPTIONAL: client certificate not required. Default value: ON. |
| CertId | String | No | Server certificate ID. If this parameter is not specified, you need to upload a certificate and specify CertContent (server certificate content), CertKey (server certificate key), and CertName (server certificate name). |
| 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 | Upload client CA certificate name. if SSLMode=MUTUAL and there is no CertCaId, this parameter is required. |
| CertCaContent | String | No | Upload client certificate content. if SSLMode is MUTUAL and 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) |
| SSLVerifyClient | String | Specifies whether client certificate verification is enabled. this parameter is valid only when mutual authentication is enabled. |
| CertId | String | Server certificate ID. |
| CertCaId | String | Client certificate ID. |
| ExtCertIds | Array of String | Specifies the server certificate ID for multi-server certificate scenario expansion. |
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 | Request balancing method for listeners of the classic public network CLB. An empty string or wrr indicates weighted round robin. ip_hash indicates consistent hashing based on the accessed source IP address. least_conn indicates least connections. |
| 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 | CLB instance ID list |
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 network IP of the real server |
| PrivateIpAddresses | Array of String | Private network IP of the real server |
| InstanceName | String | Instance name of the real server |
| RunFlag | Integer | Backend service 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. |
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. |
| 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. available values: CLB (instance dimension configuration), SERVER (service dimension configuration), LOCATION (rule dimension configuration). |
| ConfigName | String | Configuration name |
| ConfigContent | String | Configuration content. |
| CreateTimestamp | String | Specifies the configured creation time. Format: YYYY-MM-DD HH:MM:ss. |
| UpdateTimestamp | String | Specifies the modification time of the configuration. Format: YYYY-MM-DD HH:MM:ss. |
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 | Submachine instance ID. |
| InstanceName | String | Submachine instance name. |
| 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 | Required | Description |
|---|---|---|---|
| ZhiTong | Boolean | No | Whether to enable VIP Direct Connect |
| TgwGroupName | String | No | TgwGroup name |
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 information |
| 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. It is enabled by default. |
| TimeOut | Integer | No | Health check response timeout, in seconds. Value range: 2–60. Default value: 2. The response timeout should be less than the check interval. |
| IntervalTime | Integer | No | Health check interval, in seconds. Default value: 5. Value range: 2–300 for IPv4 CLB instances and 5–300 for IPv6 CLB instances. Note: The value range is 5–300 for some IPv4 CLB instances of early versions. |
| HealthNum | Integer | No | Healthy threshold. Default: 3, indicating that if a forwarding is found healthy three consecutive times, it is considered to be normal. Value range: 2-10. Unit: times. |
| UnHealthNum | Integer | No | Unhealthy threshold. Default: 3, indicating that if a forwarding is found unhealthy three consecutive times, it is considered to be exceptional. Value range: 2-10. Unit: times. |
| HttpCode | Integer | No | Health check status code. (This parameter applies only to HTTP/HTTPS forwarding rules and the HTTP health check method of TCP listeners.) Value range: 1–31. Default value: 31. 1: return 1xx after the check (healthy); 2: return 2xx after the check (healthy); 4: return 3xx after the check (healthy); 8: return 4xx after the check (healthy); 16: return 5xx after the check (healthy). If you expect that multiple codes represent a healthy real server, set the value to the sum of 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, which will be contained in a Host header field of the HTTP protocol. (This parameter applies only to HTTP/HTTPS listeners and the HTTP health check method of TCP listeners. For TCP listeners, this parameter is required if the HTTP health check method is used.) 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). Default: HEAD. Valid values: HEAD and GET. Note: This field may return null, indicating that no valid values can be obtained. |
| CheckPort | Integer | No | Custom check parameters. health check port, defaults to the port of the backend service unless you want to specify a specific port, otherwise leave it blank. pass the parameter value -1 to restore default settings. (applicable only to TCP/UDP listener). Note: This field may return null, indicating that no valid values can be obtained. |
| ContextType | String | No | A custom check parameter, which is required if the value of CheckType (health check protocol) is CUSTOM. This parameter represents the input format of the health check. Valid values: HEX and 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 | A custom check parameter, which is required if the value of CheckType (health check protocol) 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 | A custom check parameter, which is required if the value of CheckType (health check protocol) 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 | Protocol used for health checks. Valid values: TCP (for TCP listeners, TCP_SSL listeners, and QUIC listeners), HTTP (for TCP listeners, TCP_SSL listeners, QUIC listeners, HTTP rules, and HTTPS rules), HTTPS (for HTTPS rules), GRPC (for HTTP rules and HTTPS rules), PING (for UDP listeners), and CUSTOM (for UDP listeners and TCP listeners). The default value is HTTP for HTTP listeners, TCP for TCP, TCP_SSL, and QUIC listeners, and PING for UDP listeners. For HTTPS listeners, the protocol is the same as the backend forwarding protocol. |
| HttpVersion | String | No | HTTP version. This field indicates the HTTP version of real servers and is required if the value of CheckType is HTTP. Valid values: HTTP/1.0 and HTTP/1.1. (This field applies only to TCP listeners.) Note: This field may return null, indicating that no valid values can be obtained. |
| SourceIpType | Integer | No | Source IP address type for health checks. 0: use the LB VIP as the source IP address; 1: use an IP address in the 100.64 range as the source IP address. |
| ExtendedCode | String | No | Health check status code when the protocol is GRPC. (This parameter applies only to rules with the backend forwarding protocol of GRPC.) Default value: 12. You can enter a single numerical value, multiple numerical values, or a range. For example, 20, 20,25, or 0-99. 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 | Specifies the clb domain name. |
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: Postpaid by traffic on an hourly basis. BANDWIDTH_POSTPAID_BY_HOUR: Postpaid by bandwidth on an hourly basis. International site users do not support this billing mode. BANDWIDTH_PACKAGE: Charged by bandwidth package. BANDWIDTH_PREPAID: Bandwidth prepaid. |
| InternetMaxBandwidthOut | Integer | No | Maximum outbound bandwidth, in Mbps. This parameter is valid only for public network shared, LCU-supported, and exclusive CLB instances and private network LCU-supported CLB instances. - The range of the maximum outbound bandwidth for public network shared and exclusive CLB instances is 1 Mbps to 2,048 Mbps. - The range of the maximum outbound bandwidth for public network and private network LCU-supported CLB instances is 1 Mbps to 61,440 Mbps. (If this parameter is not specified when CreateLoadBalancer is called to create a CLB instance, the default value of 10 Mbps is used. This value can be modified.) |
| BandwidthpkgSubType | String | No | Bandwidth package type, for example BGP (multi-line). Type as follows:. SINGLEISP: single isp. BGP: multi-line. HIGH_QUALITY_BGP: specifies a dedicated bgp bandwidth package. SINGLEISP_CMCC: specifies a cmcc bandwidth package. SINGLEISP_CTCC: specifies the ctcc bandwidth package. SINGLEISP_CUCC: specifies the china unicom bandwidth package. 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: CreateLoadBalancer, DescribeLoadBalancerListByCertId, DescribeLoadBalancers, DescribeLoadBalancersDetail, InquiryPriceCreateLoadBalancer, InquiryPriceRenewLoadBalancer.
| Name | Type | Required | Description |
|---|---|---|---|
| RenewFlag | String | No | Reserved field. |
| Period | Integer | No | Reserved field. |
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 |
Operation protection information of cloud load balancer.
Used by actions: DescribeLBOperateProtect.
| Name | Type | Description |
|---|---|---|
| LoadBalancerId | String | CLB instance ID. |
| ProtectState | Boolean | Protected status. true means operation protection is enabled. false means operation protection is disabled. |
| OperatorUin | String | Specifies the uin for operation protection setting. Note: This field may return null, indicating that no valid values can be obtained. |
| Description | String | Specifies the description when setting operation protection. Note: This field may return null, indicating that no valid values can be obtained. |
| ModifyTime | String | Specifies the last modification time. Note: This field may return null, indicating that no valid values can be obtained. |
Querying the input data types
Used by actions: DescribeLBListeners.
| Name | Type | Required | Description |
|---|---|---|---|
| VpcId | String | Yes | VPC ID in string format. Only string format is supported. Can be queried through the DescribeVpcs api. |
| PrivateIp | String | Yes | Specifies the private IP address for backend querying, which can be CVM or eni. Can be queried through the DescribeAddresses api. |
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 | vpcId of RS |
| Weight | Integer | RS weight |
Listener information
Used by actions: DescribeListeners.
| Name | Type | Description |
|---|---|---|
| ListenerId | String | CLB listener ID |
| Protocol | String | Listener protocol. valid values: TCP, UDP, HTTP, HTTPS, TCP_SSL, QUIC. |
| Port | Integer | Listener port. value range: 1-65535. |
| 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. WRR, LEAST_CONN, and IP_HASH respectively indicate weighted round robin, least connections, and IP hash.Note: This field may return null, indicating that no valid values can be obtained. |
| SessionExpireTime | Integer | Session persistence time, in seconds. value range: 30-3600. default value: 0, indicating that session persistence is not enabled by default. this parameter applies only to TCP and UDP listeners. Note: This field may return null, indicating that no valid values can be obtained. |
| SniSwitch | Integer | Specifies whether to enable the SNI feature. 1: enable; 0: disable. this parameter is applicable only to HTTPS listeners. |
| 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 |
| CreateTime | String | Listener creation time |
| EndPort | Integer | End port of the port range. value range: 2-65535. |
| TargetType | String | Backend server type. available values: NODE, POLARIS, TARGETGROUP, TARGETGROUP-V2. 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. NORMAL: Default session persistence type; QUIC_CID: Session persistence by Quic Connection ID. |
| 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 | Supports Nat64 CLB TCP listeners only |
| DeregisterTargetRst | Boolean | Reschedules when unbinding real servers. only supported for TCP/UDP listeners. toggle on to enable this feature. |
| AttrFlags | Array of String | Describes the attributes of the listener. |
| 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 connections to a listener. -1 indicates unlimited speed at the listener dimension. |
| MaxCps | Integer | Maximum number of new connections to a listener. -1 means no speed limit at the listener dimension. |
| 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. |
| RescheduleInterval | Integer | Rescheduling trigger duration, valid values: 0-3600s. only TCP/UDP listeners support this. after triggering rescheduling, persistent connections will disconnect and be reassigned within the set scheduling time. |
| DataCompressMode | String | Data compression mode. |
| RescheduleStartTime | Integer | Reschedules the startup time. when configured, rescheduling will be triggered upon arrival of the start time. |
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) |
| Targets | Array of Backend | List of real servers bound to the listener (applicable only to TCP/UDP/TCP_SSL listener) |
| EndPort | Integer | End port in a port range if port range is supported, or 0 if port range is not supported |
Health check information of the listener
Used by actions: DescribeTargetHealth.
| Name | Type | Description |
|---|---|---|
| ListenerId | String | Listener ID |
| ListenerName | String | Listener name. |
| Protocol | String | Listener protocol |
| Port | Integer | Listener port |
| Rules | Array of RuleHealth | List of forwarding rules of the listener |
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 a port range for a listener |
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 | Network type of the load balancing instance. OPEN: public network attribute. INTERNAL: private network attribute. for a cloud load balancer with private network attribute, you can bind an EIP for public network access. for details, see the EIP document on binding elastic IP (https://www.tencentcloud.com/document/product/215/16700?from_cn_redirect=1). |
| Forward | Integer | No | CLB type identifier. Value range: 1 (CLB); 0 (classic CLB). |
| Domain | String | No | The domain name of the cloud load balancer instance. this field is only provided for public network classic and domain name-based load balancing instances. it is being gradually phased out. we recommend using LoadBalancerDomain instead. |
| LoadBalancerVips | Array of String | No | List of VIPs of a CLB instance. |
| Status | Integer | No | Specifies the state of the load balancing instance, including. 0: creating. 1: normal operation. |
| CreateTime | String | No | CLB instance creation time Format: YYYY-MM-DD HH:MM:ss. |
| StatusTime | String | No | Last status transition time of the CLB instance. Format: YYYY-MM-DD HH:MM:ss. |
| ProjectId | Integer | No | ID of the project to which a CLB instance belongs. 0: default project. |
| VpcId | String | No | VPC ID |
| OpenBgp | Integer | No | Anti-DDoS Pro identifier for CLB. 1: CLB with Anti-DDoS Pro; 0: CLB without Anti-DDoS Pro. |
| Snat | Boolean | No | Whether SNAT is enabled. for traditional private network clbs before december 2016, SNAT was enabled. |
| Isolation | Integer | No | Whether isolated. 0 means not isolated. 1 means isolated. |
| SubnetId | String | No | Subnet of the CLB instance (applicable only to VPC-type CLB instances on private networks) |
| Tags | Array of TagInfo | No | CLB instance tag information |
| SecureGroups | Array of String | No | Security group of the CLB instance |
| TargetRegionInfo | TargetRegionInfo | No | Basic information of real servers bound to the CLB instance |
| AnycastZone | String | No | Anycast CLB release domain. For non-anycast CLB, this field returns an empty string. |
| AddressIPVersion | String | No | IP Version, ipv4 | ipv6 |
| NumericalVpcId | Integer | No | Specifies the VPC ID in numerical form, obtainable through the DescribeVpcs API (https://www.tencentcloud.com/document/product/215/15778?from_cn_redirect=1). |
| VipIsp | String | No | Specifies the ISP of the load balancer IP address. -BGP (multi-line). - CMCC: CMCC single line network. -CTCC: ctcc single-line. - CUCC: china unicom single-line. 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 | Specifies the isolation time of the cloud load balancer instance. Format: YYYY-MM-DD HH:MM:ss. 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 | Log set ID of Cloud Log Service (CLS) for CLB |
| LogTopicId | String | No | Log topic ID of Cloud Log Service (CLS) for CLB |
| 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 |
| ConfigId | String | No | Custom configuration IDs of CLB instances |
| LoadBalancerPassToTarget | Boolean | No | Whether the real server allows traffic from CLB |
| ExclusiveCluster | ExclusiveCluster | No | Exclusive cluster on the private network |
| IPv6Mode | String | No | Specifies the field is meaningful when the IP address version is ipv6. valid values: ipv6Nat64 | ipv6FullChain. IPv6Nat64: specifies a load balancer based on Nat64 IPv6 transition technology. IPv6FullChain: specifies a cloud load balancer implemented based on ipv6 single-stack technology. Note: This field may return null, indicating that no valid values can be obtained. |
| SnatPro | Boolean | No | Specifies whether SnatPro is enabled. |
| SnatIps | Array of SnatIp | No | Enables the SnatIp list after turning on SnatPro load balancing. |
| SlaType | String | No | Performance capacity specification.
|
| IsBlock | Boolean | No | Whether VIP is blocked |
| IsBlockTime | String | No | Specifies the blocking or unblocking time. Format: YYYY-MM-DD HH:MM:ss. |
| LocalBgp | Boolean | No | Whether the IP type is 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 IPv4 and IPv6 CVM instances simultaneously. |
| 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 log set ID of Cloud Log Service (CLS) for CLB |
| HealthLogTopicId | String | No | Health check log topic ID of Cloud Log Service (CLS) for CLB |
| 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 | Attributes of cloud load balancer, input an array of strings to determine whether it is enabled. DeleteProtect: specifies deletion protection. once enabled, it prevents the cloud load balancer from being accidentally deleted. UserInVisible: invisible to users, controls load balancing visibility to users. BlockStatus: specifies the blockage status, used to limit certain operations or traffic for cloud load balancer. NoLBNat: disables the NAT feature of cloud load balancer for direct forwarding of traffic in specific scenarios. BanStatus: specifies the blocking status for suspending the clb service or restricting access. ShiftupFlag: specifies the upgrade flag used to identify if the cloud load balancer requires a configuration upgrade or performance improvement. Specifies the stopped status. once enabled, the cloud load balancer suspends service. NoVpcGw: specifies not to use VPC gateway to bypass the gateway for direct traffic handling. SgInTgw: specifies the security group in TGW (Transit Gateway) involving network security policy configuration. SharedLimitFlag: specifies the shared limit flag used to control the resource constraints of cloud load balancer. WafFlag: specifies the Web application firewall (WAF) flag. enabled to enable WAF protection. IsDomainCLB: indicates whether the cloud load balancer is domain name-based for traffic distribution. IPv6Snat: IPv6 source address translation (Snat), used for source address processing in IPv6 networks. HideDomain. specifies whether to hide the domain name for privacy protection or to avoid exposing it in specific scenarios. JumboFrame: specifies giant frame support. once enabled, it supports larger data frames to improve network efficiency. NoLBNatL4IPdc: specifies layer 4 IP direct connection without NAT, used for direct forwarding of IP traffic in layer 4 load balancing. VpcGwL3Service: specifies the VPC gateway layer-3 Service, which involves the gateway feature of the layer-3 network. Ipv62Flag: specifies the Ipv6 expansion Flag for specific feature support. Ipv62ExclusiveFlag: specifies the Ipv6 exclusive flag used for exclusive Ipv6 traffic processing. BgpPro: specifies BGP Pro support. ToaClean: TOA (TCP Option Address) cleanup. clears Address information in TCP options. |
| LoadBalancerDomain | String | No | Specifies the domain name of the load balancing instance. |
| Egress | String | No | Specifies the network outbound. |
| Exclusive | Integer | No | Indicates whether the instance type is dedicated. 1: dedicated instance. 0: non-dedicated instance. Note: This field may return null, indicating that no valid values can be obtained. |
| TargetCount | Integer | No | Specifies the number of bound backend services. |
| AssociateEndpoint | String | No | Specifies the Endpoint id associated with the clb instance. |
CLB instance details
Used by actions: DescribeLoadBalancersDetail.
| Name | Type | Description |
|---|---|---|
| LoadBalancerId | String | CLB instance ID. |
| LoadBalancerName | String | CLB instance name. |
| LoadBalancerType | String | Network type of the load balancing instance. Public: Public network attribute. Private: Private network attribute. for Private network cloud load balancer, bind EIP for Public network access. refer to EIP document. 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 for the IP address of the CLB instance. Valid values: BGP (multi-line), CMCC (China Mobile), CUCC (China Unicom), CTCC (China Telecom), INTERNAL (private network).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 | Billing type of a CLB instance. Valid values: PREPAID (prepaid), POSTPAID_BY_HOUR (pay-as-you-go).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 to enable moving up CLB security groups. Valid values: 1 (enabled), 0 (not enabled).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 | Specifies the domain name of the load balancing instance. |
| Egress | String | Specifies the network outbound. |
| AttributeFlags | Array of String | Specifies the attributes of cloud load balancer. Note: This field may return null, indicating that no valid values can be obtained. |
| SlaType | String | Specification type information for load balancing instances
Note: This field may return null, indicating that no valid values can be obtained. |
| Exclusive | Integer | 0 means non-dedicated instance. 1 means dedicated instance. 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 | Specifies the name of the load balancing instance. |
| Listeners | Array of ListenerHealth | Listener list |
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 | Specifies the CLB domain name. |
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. |
| SSLVerifyClient | String | No | Whether to enable client authentication for mutual authentication. ON: enable it; OPTIONAL: client certificate not required. Default value: ON. |
OAuth configuration information.
Used by actions: DescribeListeners, DescribeRewrite, ModifyRule.
| Name | Type | Required | Description |
|---|---|---|---|
| OAuthEnable | Boolean | No | Specifies whether to turn on or off authentication. True: enable. False: disabled. Disabled by default. |
| OAuthFailureStatus | String | No | Deny requests or allow when all iaps fail. BYPASS: specifies the bypass. REJECT. Defaults to BYPASS. |
Price of CLB instances.
Used by actions: InquiryPriceCreateLoadBalancer, InquiryPriceModifyLoadBalancer, InquiryPriceRefundLoadBalancer, InquiryPriceRenewLoadBalancer.
| Name | Type | Description |
|---|---|---|
| InstancePrice | ItemPrice | Describes the instance pricing. |
| 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. value range:. |
| 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. |
| TypeSet | Array of TypeInfo | Operator type info. |
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 the redirection target. this field is valid only when redirection is configured. Note: This field may return null, indicating that no valid values can be obtained. |
| TargetLocationId | String | Specifies the forwarding rule ID of redirection target. field is valid only when redirection is configured. Note: This field may return null, indicating that no valid values can be obtained. |
| RewriteCode | Integer | Specifies the redirection status code. |
| TakeUrl | Boolean | Whether the matched URL is carried in redirection |
| RewriteType | String | Redirection type. Manual: Manual redirection; Auto: Automatic redirection |
Data type of the modified node tag.
Used by actions: BatchModifyTargetTag.
| Name | Type | Required | Description |
|---|---|---|---|
| ListenerId | String | Yes | CLB listener ID. |
| Targets | Array of Target | Yes | List of real servers with tags to be modified. |
| LocationId | String | No | Forwarding rule ID, which is required only for Layer-7 rules but not for Layer-4 rules. |
| Tag | String | No | Modified Tag of the backend service. this parameter has a lower priority than the Tag parameter in the aforementioned Target. the final Tag value is based on the Tag parameter in the Target. the Tag parameter in RsTagRule will be used only when the Tag parameter in the Target is empty. |
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. |
| 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. |
| RuleId | String | Advanced routing rule ID. |
| Targets | Array of TargetHealth | Indicates the health check status of the backend service bound to this rule. |
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 duration, in seconds. 0 indicates that session persistence is disabled, and a value ranging from 30 to 86400 indicates that session persistence is enabled. |
| 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 | Specifies the forwarding protocol between cloud load balancer and backend service. currently supports HTTP/HTTPS/GRPC/GRPCS/TRPC. TRPC is not yet available. default 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. |
| CookieName | String | No | Specifies the custom cookie name. |
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 |
| Url | String | Path of forwarding rules. |
| SessionExpireTime | Integer | Session persistence time |
| HealthCheck | HealthCheck | Health Check Information |
| Certificate | CertificateOutput | Certificate information Note: This field may return null, indicating that no valid values can be obtained. |
| Scheduler | String | Request forwarding method in the rules.WRR, LEAST_CONN, and IP_HASH respectively indicate weighted round robin, least connections, and IP hash. |
| ListenerId | String | ID of the listener to which the forwarding rule belongs |
| RewriteTarget | RewriteTarget | Redirection target information of the forwarding rule |
| 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. NODE indicates binding to a general node, and TARGETGROUP indicates binding to a target group. |
| 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. |
| TrpcCallee | String | Called server routing. valid when ForwardType is TRPC. currently not yet available. |
| TrpcFunc | String | TRPC calling service api. valid when ForwardType is TRPC. currently not yet available. |
| QuicStatus | String | QUIC status. QUIC_ACTIVE means enabled, QUIC_INACTIVE means not enabled. note that only HTTPS domain names can enable QUIC. |
| Domains | Array of String | Specifies the domain name list of the forwarding rule. |
| TargetGroupList | Array of BasicTargetGroupInfo | List of bound target groups Note: This field may return null, indicating that no valid values can be obtained. |
| OAuth | OAuth | OAuth configuration status. |
| CookieName | String | Specifies the custom cookie name. |
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 |
| FunctionTargets | Array of FunctionTarget | Describes the backend cloud function info. |
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 | CLB instance ID. Can be queried through the DescribeLoadBalancers api. |
| SlaType | String | Yes | Specification of the LCU-supported instance. Valid values: |
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 | Specifies the specification type. |
| Availability | String | Specification availability. resource availability, "Available": Available, "Unavailable": Unavailable. |
CLB tag information
Used by actions: AddCustomizedConfig, CloneLoadBalancer, CreateLoadBalancer, CreateTargetGroup, DescribeLoadBalancerListByCertId, DescribeLoadBalancers, DescribeLoadBalancersDetail, DescribeTargetGroupList, DescribeTargetGroups.
| 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: BatchModifyTargetTag, BatchModifyTargetWeight, DeregisterTargets, ModifyTargetPort, ModifyTargetWeight, RegisterTargets.
| Name | Type | Required | Description |
|---|---|---|---|
| Port | Integer | Yes | Specifies the listening port of the backend service. Note: this parameter must be specified when binding to CVM (cloud virtual machine) or ENI (elastic network interface). |
| Type | String | No | Specifies the backend service type. valid values: CVM (cloud virtual machine), ENI (elastic network interface). as an input parameter, this parameter does not take effect currently. |
| InstanceId | String | No | This parameter must be passed in when binding to CVM. it represents the unique ID of the CVM and can be obtained from the InstanceId field in the response of the DescribeInstances api. indicates binding the primary IPv4 address of the primary network interface. the InstanceId cannot be specified in the following scenarios: binding to non-CVM resources, binding to auxiliary network interface ips on CVM, binding to CVM through cross-domain 2.0, and binding to IPv6 addresses of CVM. Note: you can only input one of the InstanceId parameter or the EniIp parameter. |
| 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 | This parameter must be passed in for IP binding. it supports eni ips and other private IP addresses. if it is an eni, it must first be bound to a CVM before binding to a cloud load balancer instance. Note: only one of the InstanceId parameter and EniIp parameter can be passed. if binding a dual-stack IPV6 instance, this parameter must be passed. if it is a cross-region binding, the parameter must be passed and the InstanceId parameter is not supported. |
| Tag | String | No | Tag. |
Association between rule and target group
Used by actions: AssociateTargetGroups, DisassociateTargetGroups.
| Name | Type | Required | Description |
|---|---|---|---|
| LoadBalancerId | String | Yes | CLB instance ID |
| TargetGroupId | String | Yes | Target group ID |
| ListenerId | String | No | Listener ID. This parameter is required when the AssociateTargetGroups and DisassociateTargetGroups APIs are called. |
| LocationId | String | No | Forwarding rule ID |
| Weight | Integer | No | Weight of the target group. Value range: [0, 100]. It takes effect only for binding v2 target groups. If not specified, it defaults to 10. |
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 | Specifies the listening port of the backend service. for a port range listener, this field returns 0, representing an invalid port, indicating settings not supported. |
| Weight | Integer | Forwarding weight of real server. Value range: [0, 100]. Default value: 10. |
| PublicIpAddresses | Array of String | Public network IP of the real server |
| PrivateIpAddresses | Array of String | Private network IP of the real server |
| InstanceName | String | Instance name of the real server |
| RegisteredTime | Timestamp | Real server binding time Note: this field may return null, indicating that no valid values can be obtained. |
| EniId | String | Unique ID of the ENI |
| ZoneId | Integer | Specifies the availability zone ID of the backend service. |
Details of target group health check
Used by actions: CreateTargetGroup, DescribeTargetGroupList, DescribeTargetGroups, ModifyTargetGroupAttribute.
| Name | Type | Required | Description |
|---|---|---|---|
| HealthSwitch | Boolean | Yes | Whether to enable the health check. |
| Protocol | String | No | Health check method. among them, only the new version V2 target group type supports this parameter. valid values: TCP | HTTP | HTTPS | PING | CUSTOM. among them:. |
| Port | Integer | No | Custom check parameters. health check port, defaults to the port of the backend service unless you want to specify a specific port, otherwise leave it blank. (applicable only to TCP/UDP target group). |
| Timeout | Integer | No | Health check timeout. The default is 2 seconds. Value range: 2-30 seconds. |
| GapTime | Integer | No | Detection interval time. The default is 5 seconds. Value range: 2-300 seconds. |
| GoodLimit | Integer | No | Health detection threshold. The default is 3 times. Value range: 2-10 times. |
| BadLimit | Integer | No | Unhealth detection threshold. The default is 3 times. Value range: 2-10 times. |
| JumboFrame | Boolean | No | Indicates whether jumbo frames are enabled for probe packets of all rss in the target group. enabled by default. this parameter is supported only for GWLB type target groups. |
| HttpCode | Integer | No | Health check status code (applicable only to HTTP/HTTPS target group and HTTP health check method of TCP target group). value range: 1~31. default: 31. among them: Note: This field may return null, indicating that no valid values can be obtained. |
| HttpCheckDomain | String | No | Health check domain name. among them: 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. |
| HttpCheckMethod | String | No | Health check method (applicable only to HTTP/HTTPS forwarding rules and HTTP health checks of TCP listeners). Default: HEAD. Valid values: HEAD and GET. Note: This field may return null, indicating that no valid values can be obtained. |
| ContextType | String | No | Input format of health check. required when health check method is CUSTOM. valid values: HEX or TEXT. among them: Note: This field may return null, indicating that no valid values can be obtained. |
| SendContext | String | No | CUSTOM check parameters. required when the CheckType value is CUSTOM, represents the content of the request sent by the health check, only ASCII visible characters, maximum length limit 500. applicable only to TCP/UDP target group. Note: This field may return null, indicating that no valid values can be obtained. |
| RecvContext | String | No | CUSTOM check parameters. required when the CheckType value is CUSTOM. represents the result returned by the health check. only ASCII visible characters are allowed. maximum length limit is 500. (applicable only to TCP/UDP target group). Note: This field may return null, indicating that no valid values can be obtained. |
| HttpVersion | String | No | HTTP version, where: Note: This field may return null, indicating that no valid values can be obtained. |
| ExtendedCode | String | No | Health check status code when the protocol is GRPC. (this parameter applies only to target groups with the backend forwarding protocol of GRPC.) default value: 12. valid values: a single numerical value, multiple numerical values, or a range. for example, 20, 20,25, or 0-99. 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 | Specifies the default port of the target group. for a full listen target group, this field returns 0, indicating an invalid port. 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 | Associated rule array. This parameter cannot be obtained when the DescribeTargetGroupList API is called.Note: This field may return null, indicating that no valid values can be obtained. |
| Protocol | String | Backend forwarding protocol of the target group. only returns valid values for the new version (v2) target group. Note: This field may return null, indicating that no valid values can be obtained. |
| ScheduleAlgorithm | String | Scheduling algorithm. returns a valid value only when the backend forwarding protocol is HTTP, HTTPS, or GRPC. available values:. Note: This field may return null, indicating that no valid values can be obtained. |
| HealthCheck | TargetGroupHealthCheck | Health check details. Note: This field may return null, indicating that no valid values can be obtained. |
| TargetGroupType | String | Target group type, currently supported v1 (legacy version target group) and v2 (new version target group). defaults to v1 (legacy version target group). |
| AssociatedRuleCount | Integer | Number of rules associated with the target group. |
| RegisteredInstancesCount | Integer | Specifies the number of instances in the target group. |
| Tag | Array of TagInfo | Tag. |
| Weight | Integer | Default weight. only target groups of v2 type return this field. when NULL is returned, it means the default weight is not set. Note: This field may return null, indicating that no valid values can be obtained. |
| FullListenSwitch | Boolean | Specifies whether to listen to all target groups. |
| KeepaliveEnable | Boolean | Whether to enable persistent connections. valid only when the backend forwarding protocol is HTTP/HTTPS/GRPC and returned by the target group. |
| SessionExpireTime | Integer | Session persistence time. valid only when the backend forwarding protocol is HTTP/HTTPS/GRPC and the target group returns a valid value. |
| IpVersion | String | IP version. |
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 | No | Port of target group instance. this field is not supported for full listen target groups. |
| Weight | Integer | No | Weight of a target group instance Specifies that the Weight must be configured for a v2 target group. when calling the CreateTargetGroup API for target group creation, this parameter is used in combination with the Weight parameter in the create api, and one of them is required. Valid values: 0-100. |
| NewPort | Integer | No | The new port of the target group instance. this field is not supported for full listen target groups. |
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 | Describes the detailed information of the current health status. for example: Alive, Dead, Unknown, Close. Alive status is healthy, Dead state is abnormal, Unknown status includes not started, checking, Unknown status, Close means health check disabled or listener status stop. |
| TargetGroupId | String | Target group unique ID. |
| Weight | Integer | Specifies the weight of the Target. |
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 |
| NumericalVpcId | Integer | No | Target'S network, in the format of 86323 for a private network, or 0 if it is a basic network. |
ISP Type
Used by actions: DescribeResources.
| Name | Type | Description |
|---|---|---|
| Type | String | Operator type. |
| SpecAvailabilitySet | Array of SpecAvailability | Specification availability. |
AZ information
Used by actions: DescribeLoadBalancerListByCertId, DescribeLoadBalancers.
| Name | Type | Required | Description |
|---|---|---|---|
| ZoneId | Integer | No | Unique ID of the AZ in numeric form, such as 100001 |
| Zone | String | No | Unique ID of the AZ in string format, such as ap-guangzhou-1 |
| ZoneName | String | No | AZ name, such as Guangzhou 1 |
| ZoneRegion | String | No | Specifies the region of the availability zone, for example: ap-guangzhou. |
| LocalZone | Boolean | No | Indicates whether the AZ is a LocalZone az, for example: false. |
| EdgeZone | Boolean | No | Indicates whether the AZ is an EdgeZone az, for example: false. |
List of AZs
Used by actions: DescribeResources.
| Name | Type | Description |
|---|---|---|
| MasterZone | String | Primary AZ, such as "ap-guangzhou-1". |
| ResourceSet | Array of Resource | Resource list. |
| 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 | Specifies the network outbound. |
피드백