tencent cloud

APIs

文档APIsGateway Load BalancerData Types

数据结构

Download
聚焦模式
字号
最后更新时间： 2026-05-08 14:52:07

AssociationItem

目标组关联到的规则

被如下接口引用：DescribeTargetGroupList, DescribeTargetGroups。

名称 类型 描述
LoadBalancerId String 关联到的网关负载均衡实例ID
LoadBalancerName String 网关负载均衡实例名称

Filter

过滤器条件

被如下接口引用：DescribeGatewayLoadBalancers, DescribeTargetGroupInstances, DescribeTargetGroupList, DescribeTargetGroups。

名称 类型 必选 描述
Name String 是 过滤器的名称
Values Array of String 是 过滤器的值数组

GatewayLoadBalancer

网关负载均衡实例的信息

被如下接口引用：DescribeGatewayLoadBalancers。

名称 类型 描述
LoadBalancerId String 网关负载均衡实例 ID。
LoadBalancerName String 网关负载均衡实例的名称。
VpcId String 网关负载均衡所属私有网络。
SubnetId String 网关负载均衡所属子网。
Vips Array of String 网关负载均衡提供服务的虚拟IP。
Status Integer 网关负载均衡实例状态。
0：创建中，1：正常运行，3：删除中。
TargetGroupId String 关联的目标组唯一ID。
DeleteProtect Boolean 是否开启删除保护功能。
Tags Array of TagInfo 负载均衡实例的标签信息。
CreateTime String 创建时间。
ChargeType String 网关负载均衡实例的计费类型，POSTPAID_BY_HOUR：按量计费
Isolation Integer 0：表示未被隔离，1：表示被隔离。
IsolatedTime String 网关负载均衡实例被隔离的时间
OperateProtect Boolean 是否开启配置修改保护功能。

ItemPrice

描述了单项的价格信息

被如下接口引用：InquirePriceCreateGatewayLoadBalancer。

名称 类型 描述
UnitPrice Float 后付费单价，单位：元。
ChargeUnit String 后付费计价单元，可取值范围： HOUR：表示计价单元是按每小时来计算。当前涉及该计价单元的场景有：实例按小时后付费（POSTPAID_BY_HOUR）。
OriginalPrice Float 预支费用的原价，单位：元。
注意：此字段可能返回 null，表示取不到有效值。
DiscountPrice Float 预支费用的折扣价，单位：元。
注意：此字段可能返回 null，表示取不到有效值。
UnitPriceDiscount Float 后付费的折扣单价，单位:元。
Discount Float 折扣，如20.0代表2折。

Price

表示网关负载均衡的价格

被如下接口引用：InquirePriceCreateGatewayLoadBalancer。

名称 类型 描述
InstancePrice ItemPrice 描述了实例价格。
LcuPrice ItemPrice 描述了GLCU的价格。

TagInfo

网关负载均衡的标签信息

被如下接口引用：CreateGatewayLoadBalancer, CreateTargetGroup, DescribeGatewayLoadBalancers, DescribeTargetGroupList, DescribeTargetGroups。

名称 类型 必选 描述
TagKey String 是 标签的键
TagValue String 是 标签的值

TargetGroupAssociation

规则与目标组的关联关系。

被如下接口引用：AssociateTargetGroups, DisassociateTargetGroups。

名称 类型 必选 描述
LoadBalancerId String 是 网关负载均衡实例ID，可以通过DescribeGatewayLoadBalancers获取网关负载均衡ID。
TargetGroupId String 是 目标组ID，可以通过DescribeTargetGroups获取目标组ID。

TargetGroupBackend

目标组绑定的后端服务器

被如下接口引用：DescribeTargetGroupInstances。

名称 类型 描述
TargetGroupId String 目标组ID
Type String 后端服务的类型，可取：CVM、ENI
InstanceId String 后端服务的唯一 ID
Port Integer 后端服务的监听端口
Weight Integer 后端服务的转发权重，取值为0或16
PublicIpAddresses Array of String 后端服务的外网 IP
PrivateIpAddresses Array of String 后端服务的内网 IP
InstanceName String 后端服务的实例名称
RegisteredTime Timestamp ISO8601 后端服务被绑定的时间
EniId String 弹性网卡唯一ID
ZoneId Integer 后端服务的可用区ID

TargetGroupHealthCheck

目标组健康检查详情

被如下接口引用：CreateTargetGroup, DescribeTargetGroupList, DescribeTargetGroups, ModifyTargetGroupAttribute。

名称 类型 必选 描述
HealthSwitch Boolean 否 是否开启健康检查。
Protocol String 否 健康检查使用的协议。支持PING和TCP两种方式，默认为PING。

- icmp: 使用PING的方式进行健康检查
- tcp: 使用TCP连接的方式进行健康检查
Port Integer 否 健康检查端口，探测协议为tcp时，该参数必填。
Timeout Integer 否 健康检查超时时间。 默认为2秒。 可配置范围：2 - 30秒。
IntervalTime Integer 否 检测间隔时间。 默认为5秒。 可配置范围：2 - 300秒。
HealthNum Integer 否 检测健康阈值。 默认为3次。 可配置范围：2 - 10次。
UnHealthNum Integer 否 检测不健康阈值。 默认为3次。 可配置范围：2 - 10次。

TargetGroupInfo

目标组信息

被如下接口引用：DescribeTargetGroupList, DescribeTargetGroups。

名称 类型 描述
TargetGroupId String 目标组ID
VpcId String 目标组的vpcid
TargetGroupName String 目标组的名字
Port Integer 目标组的默认端口
注意：此字段可能返回 null，表示取不到有效值。
CreatedTime Timestamp ISO8601 目标组的创建时间
UpdatedTime Timestamp ISO8601 目标组的修改时间
AssociatedRule Array of AssociationItem 关联到的规则数组。在DescribeTargetGroupList接口调用时无法获取到该参数。
注意：此字段可能返回 null，表示取不到有效值。
Protocol String 网关负载均衡目标组协议。
- tencent_geneve ：GENEVE 标准协议
- aws_geneve：GENEVE 兼容协议
注意：此字段可能返回 null，表示取不到有效值。
ScheduleAlgorithm String 均衡算法。
- ip_hash_3_elastic：弹性哈希
注意：此字段可能返回 null，表示取不到有效值。
HealthCheck TargetGroupHealthCheck 健康检查详情。
注意：此字段可能返回 null，表示取不到有效值。
AllDeadToAlive Boolean 是否支持全死全活。
注意：此字段可能返回 null，表示取不到有效值。
AssociatedRuleCount Integer 目标组已关联的规则数。
注意：此字段可能返回 null，表示取不到有效值。
RegisteredInstancesCount Integer 目标组内的实例数量。
注意：此字段可能返回 null，表示取不到有效值。
Tag Array of TagInfo 目标组的标签。
ForwardingMode String 流量分发方式

- STATELESS：无状态
- STATEFUL： 有状态
TcpIdleConnectTimeout Integer TCP协议连接空闲超时时间，可配置60s-6000s，默认350s。
OthersIdleConnectTimeout Integer 其他协议连接空闲超时时间，可配置5s-180s，默认120s
RescheduleUnbindRs Boolean 重新调度功能内的解绑后端服务开关，开关打开后解绑后端服务会触发重新调度。
RescheduleUnbindRsStartTime Integer 解绑RS后开启重调度的时间，可配置0s-3600s，默认0s
RescheduleUnhealthy Boolean 重新调度功能内的后端服务健康探测异常开关，开关打开后后端服务健康检查异常会触发重新调度。
RescheduleUnhealthyStartTime Integer 后端服务健康探测异常后开启重调度的时间，可配置0s-3600s，默认0s

TargetGroupInstance

目标组实例

被如下接口引用：CreateTargetGroup, DeregisterTargetGroupInstances, ModifyTargetGroupInstancesWeight, RegisterTargetGroupInstances。

名称 类型 必选 描述
BindIP String 是 目标组实例的内网IP。
Port Integer 否 目标组实例的端口，只支持6081。
Weight Integer 否 目标组实例的权重，只支持0或16，非0统一按16处理。

TargetGroupInstanceStatus

用于目标组后端rs健康检查状态。

被如下接口引用：DescribeTargetGroupInstanceStatus。

名称 类型 描述
InstanceIp String 后端rs的IP
Status String 健康检查状态，参数值及含义如下：
● on：表示探测中。
● off：表示健康检查关闭。
● health：表示健康。
● unhealth：表示异常。
上一篇: DescribeTaskStatus下一篇: Error Codes

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈