tencent cloud

APIs

Data Types

ダウンロード
フォーカスモード
フォントサイズ
最終更新日: 2026-06-17 17:21:50

AvailableZoneAffinityInfo

Forward affinity info in availability zone

Used by actions: CreateLoadBalancer, DescribeLoadBalancerListByCertId, DescribeLoadBalancers, DescribeLoadBalancersDetail.

Name Type Required Description
Enable Boolean No Whether to enable availability zone forwarding affinity. true: enable availability zone forwarding affinity; false: enable availability zone forwarding affinity.
ExitRatio Integer No The availability zone forwarding affinity failure threshold. When the healthy ratio of backend services in an availability zone is less than this threshold, the Cloud Load Balancer will exit availability zone forwarding affinity and convert to forwarding across all availability zones.
Note: This field may return null, indicating that no valid values can be obtained.
ReentryRatio Integer No The threshold for re-enabling availability zone forwarding affinity. When forwarding is in all availability zones and the proportion of healthy backend services in the Cloud Load Balancer availability zone is greater than or equal to this threshold, the CLB will enter availability zone forwarding affinity again.
Note: This field may return null, indicating that no valid values can be obtained.

BindDetailItem

Binding relationship, including listener name, protocol, URL, and vport.

Used by actions: DescribeCustomizedConfigAssociateList.

Name Type Description
LoadBalancerId String ID of the CLB instance bound to the configuration
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
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 Location URL
Note: This field may return null, indicating that no valid values can be obtained.
ConfigId String Configuration ID

CertIdRelatedWithLoadBalancers

Certificate ID and the list of CLB instances associated with the certificate ID

Used by actions: DescribeLoadBalancerListByCertId.

Name Type Description
CertId String Certificate ID
LoadBalancers Array of LoadBalancer List of CLB instances associated with the certificate

ClassicalListener

Classic CLB listener information

Used by actions: DescribeClassicalLBListeners.

Name Type Description
ListenerId String CLB listener ID
ListenerPort Integer CLB listener port
InstancePort Integer Listener backend forwarding port
ListenerName String listener name
Protocol String Listener protocol type
SessionExpire Integer Session hold time
HealthSwitch Integer Whether health check is enabled. 1: Enabled; 0: Disabled
TimeOut Integer Response timeout duration
IntervalTime Integer check interval
HealthNum Integer health threshold
AbnormalNum 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 instance. For more information, refer to the explanation of this field in the listener creation API.
HttpCheckPath String Health check path for HTTP and HTTPS listeners of a public network Classic CLB instance
SSLMode String Authentication method for an HTTPS listener of a public network Classic CLB instance
CertId String Server certificate ID for an HTTPS listener of a public network Classic CLB instance
CertCaId String Client certificate ID for an HTTPS listener of a public network Classic CLB instance
Status Integer Listener status. 0: Creating; 1: Running

ClusterItem

Exclusive cluster information

Used by actions: CloneLoadBalancer, CreateLoadBalancer.

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

ConfigListItem

configuration content

Used by actions: DescribeCustomizedConfigList.

Name Type Description
ConfigId String Configuration ID
ConfigType String Configuration type
ConfigName String Configuration name
ConfigContent String Configuration content
CreateTimestamp String Configuration creation time
UpdateTimestamp String Configuration modification time
Tag Array of TagInfo Tag.

ExclusiveCluster

Exclusive cluster

Used by actions: CloneLoadBalancer, CreateLoadBalancer, DescribeLoadBalancerListByCertId, DescribeLoadBalancers.

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

ExtraInfo

Reserved. Generally unnecessary for users to concern.

Used by actions: DescribeLoadBalancerListByCertId, DescribeLoadBalancers, DescribeLoadBalancersDetail.

Name Type Required Description
Dnat Boolean Yes Whether to enable VIP Direct Connect
TgwGroupName String Yes TgwGroup name

Filter

Filter criteria

Used by actions: DescribeCustomizedConfigList, DescribeLoadBalancers, DescribeLoadBalancersDetail.

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

InternetAccessible

Network billing mode, maximum outbound bandwidth

Used by actions: CloneLoadBalancer, CreateLoadBalancer, DescribeLoadBalancerListByCertId, DescribeLoadBalancers, DescribeLoadBalancersDetail.

Name Type Required Description
InternetChargeType String No TRAFFIC_POSTPAID_BY_HOUR: postpaid by traffic on an hourly basis;
InternetMaxBandwidthOut Integer No Maximum outbound bandwidth in Mbps. It applies only to shared, LCU-supported, and exclusive CLB instances of the public network type and LCU-supported CLB instances of the private network type.
-For shared type and exclusive CLB instances with public network attributes, the maximum outbound bandwidth ranges from 1Mbps to 2048Mbps.
-For LCU-supported CLB instances with public network attributes and private network attributes, the maximum outbound bandwidth ranges from 1Mbps to 61440Mbps.
(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.)
BandwidthPackageSubType String No Bandwidth package type, such as SINGLEISP (single ISP) and BGP (multi ISP).
Note: This field may return null, indicating that no valid values can be obtained.

LBChargePrepaid

Retention type

Used by actions: CreateLoadBalancer, DescribeLoadBalancerListByCertId, DescribeLoadBalancers, DescribeLoadBalancersDetail.

Name Type Required Description
RenewFlag String No Reserved field.
Period Integer No Reserved field.

ListenerHealth

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

LoadBalancer

CLB instance information

Used by actions: DescribeLoadBalancerListByCertId, DescribeLoadBalancers.

Name Type Required Description
LoadBalancerId String No CLB instance ID.
LoadBalancerName String No CLB instance name.
LoadBalancerType String No Network type of the CLB instance:
OPEN: Public network attribute. INTERNAL: Intranet attribute. For a CLB with intranet attribute, you can bind EIP for public network access. For details, see the EIP document.
Forward Integer No Load balancer type identifier. 1: CLB; 0: Classic CLB.
Domain String No The domain name of the Cloud Load Balancer instance. This field is only provided by public network-based and domain name-based CLB 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 CLB instance state, including
0: creating, 1: normal operation.
CreateTime String No CLB instance creation time
StatusTime String No Last status transition time of the CLB instance.
ProjectId Integer No The ID of the project to which the 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 Private network Classic CLB instances before December 2016 had SNAT enabled.
Isolation Integer No 0: Not isolated; 1: Isolated.
Log String No User-enabled log information. Only public network CLB instances that have an HTTP or HTTPS listener can generate logs.
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
NumericalVpcId Integer No VPC ID in numerical format
VipIsp String No ISP of the load balancer IP. Value ranges from BGP to CUCC.
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 standby availability zone
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 Expiration Time of the CLB instance
Note: This field may return null, indicating that no valid values can be obtained.
ChargeType String No Billing type of the Cloud Load Balancer instance, 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 Reserved field.
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 the CLB instance
Note: This field may return null, indicating that no valid values can be obtained.
ExtraInfo ExtraInfo No Reserved. Generally unnecessary for users to concern.
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 This field is meaningful when the IP address version is IPv6. IPv6Nat64
SnatPro Boolean No Is SnatPro enabled?
SnatIps Array of SnatIp No After enabling SnatPro load balancing, the SnatIp list.
SlaType String No Performance capacity specification.
  • clb.c1.small: Minimalist specification
  • clb.c2.medium: Standard specification
  • clb.c3.small: High-tier 1 specification
  • clb.c3.medium: High-tier 2 specification
  • clb.c4.small: Super-tier 1 specification
  • clb.c4.medium: Super-tier 2 specification
  • clb.c4.large: Super-tier 3 specification
  • clb.c4.xlarge: Super-tier 4 specification
  • "": Non-LCU-supported instance
IsBlock Boolean No Whether VIP is blocked
IsBlockTime String No Blocking or unblocking time
LocalBgp Boolean No Whether the IP type is Local BGP
ClusterTag String No Layer-7 exclusive 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 VPC-based private network CLB. AZ where the rule is in proximity access mode
Note: This field may return null, indicating that no valid values can be obtained.
NfvInfo String No Whether CLB is NFV. Empty: No; l7nfv: NFV for layer 7.
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
LoadBalancerDomain String No Domain name of the CLB instance.
Egress String No Network outbound
Exclusive Integer No Whether the instance type is exclusive type. 1: Dedicated instance. 0: Non-dedicated instance.
Note: This field may return null, indicating that no valid values can be obtained.
TargetCount Integer No Number of bound backend services.
AssociateEndpoint String No Endpoint Id associated with the CLB instance.
AvailableZoneAffinityInfo AvailableZoneAffinityInfo No Availability zone forward affinity info

LoadBalancerDetail

CLB detailed information

Used by actions: DescribeLoadBalancersDetail.

Name Type Description
LoadBalancerId String CLB instance ID.
LoadBalancerName String CLB instance name.
LoadBalancerType String Network type of the CLB instance:
OPEN: public network attribute, INTERNAL: private network attribute. For a Cloud Load Balancer with private network attribute, you can bind EIP for outbound public network access. For details, see the EIP document.
Note: This field may return null, indicating that no valid values can be obtained.
Status Integer CLB instance state, including
0: creating, 1: normal operation.
Note: This field may return null, indicating that no valid values can be obtained.
Address String VIP of the CLB instance.
Note: This field may return null, indicating that no valid values can be obtained.
AddressIPv6 String IPv6 address of the VIP in the CLB instance.
Note: This field may return null, indicating that no valid values can be obtained.
AddressIPVersion String IP version of the Cloud Load Balancer instance, IPv4
IPv6Mode String IPv6 address type of the Cloud Load Balancer instance: IPv6Nat64
Zone String Availability Zone of the Cloud Load Balancer instance.
Note: This field may return null, indicating that no valid values can be obtained.
AddressIsp String The ISP to which the IP address of the CLB instance belongs. Value ranges from BGP (multi-line), CMCC (China Mobile), CUCC (China Unicom), CTCC (China Telecom) to INTERNAL (private network).
Note: This field may return null, indicating that no valid values can be obtained.
VpcId String ID of the VPC that the CLB instance belongs to.
Note: This field may return null, indicating that no valid values can be obtained.
ProjectId Integer The 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 the CLB instance. Valid values: PREPAID and POSTPAID_BY_HOUR (pay-as-you-go).
Note: This field may return null, indicating that no valid values can be obtained.
NetworkAttributes InternetAccessible Network properties of the CLB instance.
Note: This field may return null, indicating that no valid values can be obtained.
PrepaidAttributes LBChargePrepaid Prepaid billing attributes of the Cloud Load Balancer instance.
Note: This field may return null, indicating that no valid values can be obtained.
ExtraInfo ExtraInfo Reserved. Generally unnecessary for users to concern.
Note: This field may return null, indicating that no valid values can be obtained.
ConfigId String Personalized configuration ID of the Cloud Load Balancer (CLB) dimension. Multiple configurations are separated by commas.
Note: This field may return null, indicating that no valid values can be obtained.
Tags Array of TagInfo Tag information of the GWLB instance.
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 Path of forwarding rules.
Note: This field may return null, indicating that no valid values can be obtained.
TargetId String Backend target ID.
Note: This field may return null, indicating that no valid values can be obtained.
TargetAddress String Backend target IP address.
Note: This field may return null, indicating that no valid values can be obtained.
TargetPort Integer Backend target listening port.
Note: This field may return null, indicating that no valid values can be obtained.
TargetWeight Integer Backend target forwarding weight.
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 security groups bound to Cloud Load Balancer (CLB).
Note: This field may return null, indicating that no valid values can be obtained.
LoadBalancerPassToTarget Integer Valid values: 1 (enabled), 0 (not enabled). Value ranges from 1 to 0.
Note: This field may return null, indicating that no valid values can be obtained.
TargetHealth String Backend target health status.
Note: This field may return null, indicating that no valid values can be obtained.
Domains String Domain name list of the forwarding rule.
Note: This field may return null, indicating that no valid values can be obtained.
SlaveZone Array of String Multi-availability zone Cloud Load Balancer instance selected backup availability zone
Note: This field may return null, indicating that no valid values can be obtained.
Zones Array of String The availability zone of the private network CLB instance is controlled by the allowlist CLB_Internal_Zone.
Note: This field may return null, indicating that no valid values can be obtained.
SniSwitch Integer Whether to enable the SNI feature. 1: enable; 0: disable (this parameter is applicable only to HTTPS listeners).
Note: This field may return null, indicating that no valid values can be obtained.
LoadBalancerDomain String Domain name of the CLB instance.
Egress String Network outbound
AttributeFlags Array of String Attributes of Cloud Load Balancer
SlaType String Specification type information of Cloud Load Balancer instance
  • clb.c1.small: Minimalist specification
  • clb.c2.medium: Standard specification
  • clb.c3.small: Advanced type 1 specification
  • clb.c3.medium: Advanced type 2 specification
  • clb.c4.small: Super type 1 specification
  • clb.c4.medium: Super type 2 specification
  • clb.c4.large: Super type 3 specification
  • clb.c4.xlarge: Super type 4 specification
  • "": Non-LCU-supported instance

Note: This field may return null, indicating that no valid values can be obtained.
Exclusive Integer 0: Non-exclusive type instance; 1: Exclusive type instance.
Note: This field may return null, indicating that no valid values can be obtained.
AvailableZoneAffinityInfo AvailableZoneAffinityInfo Availability zone forward affinity info
Note: This field may return null, indicating that no valid values can be obtained.

LoadBalancerHealth

CLB instance health check status

Used by actions: DescribeTargetHealth.

Name Type Description
LoadBalancerId String CLB instance ID
LoadBalancerName String Load balancing instance name
Listeners Array of ListenerHealth Listener list

RsWeightRule

Modify the data type of a node weight

Used by actions: BatchModifyTargetWeight.

Name Type Required Description
ListenerId String Yes CLB listener ID.
Targets Array of Target Yes List of real servers for which weights are to be modified.
LocationId String No Forwarding rule ID, which is required only for Layer-7 rules but not for Layer-4 rules.
Domain String No Domain name of the target rule. This parameter will not take effect when LocationId parameter is provided.
Url String No URL of the target rule. This parameter will not take effect when the LocationId parameter is provided.
Weight Integer No The forwarding weight of the backend service after modification, value ranges from 0 to 100. This parameter has a lower priority than the Weight parameter in the Target (https://www.tencentcloud.com/document/api/214/30694?from_cn_redirect=1#Target). The final weight value is determined by the Weight parameter in the Target, and only when the Weight parameter in the Target is empty, the Weight parameter in the RsWeightRule takes effect.

RuleHealth

Health check status of a forwarding rule

Used by actions: DescribeTargetHealth.

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

SnatIp

SnatIp information structure

Used by actions: CloneLoadBalancer, CreateLoadBalancer, DescribeLoadBalancerListByCertId, DescribeLoadBalancers.

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

TagInfo

CLB tag information

Used by actions: CloneLoadBalancer, CreateLoadBalancer, DescribeCustomizedConfigList, DescribeLoadBalancerListByCertId, DescribeLoadBalancers, DescribeLoadBalancersDetail, SetCustomizedConfigForLoadBalancer.

Name Type Required Description
TagKey String Yes Tag key
TagValue String Yes Tag value

Target

Forwarding target, namely, a real server bound to the CLB instance

Used by actions: BatchModifyTargetWeight.

Name Type Required Description
Port Integer Yes 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 Backend service type, optional: CVM (Cloud Virtual Machine), ENI (Elastic Network Interface). As an input parameter, this parameter does not take effect.
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. It indicates binding to the primary IPv4 address of the primary network interface. The following scenarios do not support specifying InstanceId: binding to non-CVM resources, binding to auxiliary network interface IPs on CVM, binding to CVM through cross-region 2.0, and binding to IPv6 addresses of CVM.
Note: You can only input one of the InstanceId or EniIp parameter.
Weight Integer No The forwarding weight of the backend service after modification, with a value range of [0, 100], defaults to 10. This parameter has a higher priority than the Weight parameter in RsWeightRule. The final weight value is based on this Weight parameter. Only when this Weight parameter is empty, the Weight parameter 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 bind to a CVM before binding to a CLB instance.
Note: You can only input one of the InstanceId or EniIp parameter. If it is binding a dual-stack IPV6 instance, you must pass this parameter. If it is cross-region binding, you must pass the parameter, and the InstanceId parameter is not supported.

TargetHealth

Describes the health information of a target

Used by actions: DescribeTargetHealth.

Name Type Description
IP String Private network IP of target
Port Integer Port bound to the target
HealthStatus Boolean 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.
TargetId String Target instance ID, such as ins-12345678
HealthStatusDetail String Detailed information about the current health status. Alive: Healthy; Dead: Exceptional; Unknown: Check not started/Checking/Unknown status.
TargetGroupId String Target group unique ID.
Weight Integer Weight of the Target

TargetRegionInfo

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

Used by actions: DescribeLoadBalancerListByCertId, DescribeLoadBalancers.

Name Type Required Description
Region String Yes Region of the target, such as ap-guangzhou
VpcId String Yes Network of the target. For VPC, the format is vpc-abcd1234. For a basic network, the value is 0.
NumericalVpcId Integer No Target's network, in the format of 86323 for a private network, or 0 if it is a basic network

ZoneInfo

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 Region of the availability zone, such as ap-guangzhou.
LocalZone Boolean No Whether the availability zone is a local availability zone. For example, false.
EdgeZone Boolean No Whether the availability zone is an edge availability zone. For example, false.

ヘルプとサポート

この記事はお役に立ちましたか?

フィードバック