负载均衡数据结构 - API 文档 - 文档中心

负载均衡

文档中心负载均衡 API 文档数据结构

数据结构

最近更新时间：2021-07-14 08:04:37

我的收藏

本页目录：

AssociationItem

目标组关联到的规则

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

名称	类型	描述
LoadBalancerId	String	关联到的负载均衡ID
ListenerId	String	关联到的监听器ID
LocationId	String	关联到的转发规则ID 注意：此字段可能返回 null，表示取不到有效值。
Protocol	String	关联到的监听器协议类型，如HTTP,TCP,
Port	Integer	关联到的监听器端口
Domain	String	关联到的转发规则域名注意：此字段可能返回 null，表示取不到有效值。
Url	String	关联到的转发规则URL 注意：此字段可能返回 null，表示取不到有效值。
LoadBalancerName	String	负载均衡名称
ListenerName	String	监听器名称

Backend

监听器绑定的后端服务的详细信息

被如下接口引用：DescribeTargets。

名称	类型	描述
Type	String	后端服务的类型，可取：CVM、ENI
InstanceId	String	后端服务的唯一 ID，如 ins-abcd1234
Port	Integer	后端服务的监听端口
Weight	Integer	后端服务的转发权重，取值范围：[0, 100]，默认为 10。
PublicIpAddresses	Array of String	后端服务的外网 IP 注意：此字段可能返回 null，表示取不到有效值。
PrivateIpAddresses	Array of String	后端服务的内网 IP 注意：此字段可能返回 null，表示取不到有效值。
InstanceName	String	后端服务的实例名称注意：此字段可能返回 null，表示取不到有效值。
RegisteredTime	String	后端服务被绑定的时间注意：此字段可能返回 null，表示取不到有效值。
EniId	String	弹性网卡唯一ID，如 eni-1234abcd 注意：此字段可能返回 null，表示取不到有效值。

BasicTargetGroupInfo

监听器或者转发规则绑定的目标组基本信息

被如下接口引用：DescribeListeners, DescribeRewrite。

名称	类型	描述
TargetGroupId	String	目标组ID
TargetGroupName	String	目标组名称

BatchTarget

批量绑定类型

被如下接口引用：BatchDeregisterTargets, BatchRegisterTargets。

名称	类型	必选	描述
ListenerId	String	是	监听器 ID。
Port	Integer	是	绑定端口。
InstanceId	String	否	子机 ID。表示绑定主网卡主 IP。
EniIp	String	否	绑定 IP 时需要传入此参数，支持弹性网卡的 IP 和其他内网 IP，如果是弹性网卡则必须先绑定至CVM，然后才能绑定到负载均衡实例。注意：参数 InstanceId、EniIp 只能传入一个且必须传入一个。如果绑定双栈IPV6子机，必须传该参数。
Weight	Integer	否	子机权重，范围[0, 100]。绑定时如果不存在，则默认为10。
LocationId	String	否	七层规则 ID。

BlockedIP

加入了12306黑名单的IP

被如下接口引用：DescribeBlockIPList。

名称	类型	描述
IP	String	黑名单IP
CreateTime	String	加入黑名单的时间
ExpireTime	String	过期时间

CertIdRelatedWithLoadBalancers

证书ID，以及与该证书ID关联的负载均衡实例列表

被如下接口引用：DescribeLoadBalancerListByCertId。

名称	类型	描述
CertId	String	证书ID
LoadBalancers	Array of LoadBalancer	与证书关联的负载均衡实例列表注意：此字段可能返回 null，表示取不到有效值。

CertificateInput

证书信息

被如下接口引用：CreateListener, CreateRule, ModifyDomainAttributes, ModifyListener, ReplaceCertForLoadBalancers。

名称	类型	必选	描述
SSLMode	String	否	认证类型，UNIDIRECTIONAL：单向认证，MUTUAL：双向认证
CertId	String	否	服务端证书的 ID，如果不填写此项则必须上传证书，包括 CertContent，CertKey，CertName。
CertCaId	String	否	客户端证书的 ID，当监听器采用双向认证，即 SSLMode=MUTUAL 时，如果不填写此项则必须上传客户端证书，包括 CertCaContent，CertCaName。
CertName	String	否	上传服务端证书的名称，如果没有 CertId，则此项必传。
CertKey	String	否	上传服务端证书的 key，如果没有 CertId，则此项必传。
CertContent	String	否	上传服务端证书的内容，如果没有 CertId，则此项必传。
CertCaName	String	否	上传客户端 CA 证书的名称，如果 SSLMode=mutual，如果没有 CertCaId，则此项必传。
CertCaContent	String	否	上传客户端证书的内容，如果 SSLMode=mutual，如果没有 CertCaId，则此项必传。

CertificateOutput

证书相关信息

被如下接口引用：DescribeListeners, DescribeRewrite。

名称	类型	描述
SSLMode	String	认证类型，UNIDIRECTIONAL：单向认证，MUTUAL：双向认证
CertId	String	服务端证书的 ID。
CertCaId	String	客户端证书的 ID。注意：此字段可能返回 null，表示取不到有效值。

ClassicalHealth

传统型负载均衡后端服务的健康状态

被如下接口引用：DescribeClassicalLBHealthStatus。

名称	类型	描述
IP	String	后端服务的内网 IP
Port	Integer	后端服务的端口
ListenerPort	Integer	负载均衡的监听端口
Protocol	String	转发协议
HealthStatus	Integer	健康检查结果，1 表示健康，0 表示不健康

ClassicalListener

传统型负载均衡监听器信息

被如下接口引用：DescribeClassicalLBListeners。

名称	类型	描述
ListenerId	String	负载均衡监听器ID
ListenerPort	Integer	负载均衡监听器端口
InstancePort	Integer	监听器后端转发端口
ListenerName	String	监听器名称
Protocol	String	监听器协议类型
SessionExpire	Integer	会话保持时间
HealthSwitch	Integer	是否开启了健康检查：1（开启）、0（关闭）
TimeOut	Integer	响应超时时间
IntervalTime	Integer	检查间隔
HealthNum	Integer	健康阈值
UnhealthNum	Integer	不健康阈值
HttpHash	String	传统型公网负载均衡的 HTTP、HTTPS 监听器的请求均衡方法。wrr 表示按权重轮询，ip_hash 表示根据访问的源 IP 进行一致性哈希方式来分发
HttpCode	Integer	传统型公网负载均衡的 HTTP、HTTPS 监听器的健康检查返回码。具体可参考创建监听器中对该字段的解释
HttpCheckPath	String	传统型公网负载均衡的 HTTP、HTTPS 监听器的健康检查路径
SSLMode	String	传统型公网负载均衡的 HTTPS 监听器的认证方式
CertId	String	传统型公网负载均衡的 HTTPS 监听器的服务端证书 ID
CertCaId	String	传统型公网负载均衡的 HTTPS 监听器的客户端证书 ID
Status	Integer	监听器的状态，0 表示创建中，1 表示运行中

ClassicalLoadBalancerInfo

负载均衡信息

被如下接口引用：DescribeClassicalLBByInstanceId。

名称	类型	描述
InstanceId	String	后端实例ID
LoadBalancerIds	Array of String	负载均衡实例ID列表注意：此字段可能返回 null，表示取不到有效值。

ClassicalTarget

传统型负载均衡的后端服务相关信息

被如下接口引用：DescribeClassicalLBTargets。

名称	类型	描述
Type	String	后端服务的类型，可取值：CVM、ENI（即将支持）
InstanceId	String	后端服务的唯一 ID，可通过 DescribeInstances 接口返回字段中的 unInstanceId 字段获取
Weight	Integer	后端服务的转发权重，取值范围：[0, 100]，默认为 10。
PublicIpAddresses	Array of String	后端服务的外网 IP 注意：此字段可能返回 null，表示取不到有效值。
PrivateIpAddresses	Array of String	后端服务的内网 IP 注意：此字段可能返回 null，表示取不到有效值。
InstanceName	String	后端服务的实例名称注意：此字段可能返回 null，表示取不到有效值。
RunFlag	Integer	后端服务的状态 1：故障，2：运行中，3：创建中，4：已关机，5：已退还，6：退还中， 7：重启中，8：开机中，9：关机中，10：密码重置中，11：格式化中，12：镜像制作中，13：带宽设置中，14：重装系统中，19：升级中，21：热迁移中注意：此字段可能返回 null，表示取不到有效值。

ClassicalTargetInfo

传统型负载均衡的后端信息

被如下接口引用：RegisterTargetsWithClassicalLB。

名称	类型	必选	描述
InstanceId	String	是	后端实例ID
Weight	Integer	否	权重，取值范围 [0, 100]

Cluster

集群的详细信息，如集群ID，名称，类型，可用区，标签等

被如下接口引用：DescribeExclusiveClusters。

名称	类型	描述
ClusterId	String	集群唯一ID
ClusterName	String	集群名称
ClusterType	String	集群类型，如TGW，STGW，VPCGW
ClusterTag	String	集群标签，只有STGW集群有标签注意：此字段可能返回 null，表示取不到有效值。
Zone	String	集群所在可用区，如ap-guangzhou-1
Network	String	集群网络类型，如Public，Private
MaxConn	Integer	最大连接数注意：此字段可能返回 null，表示取不到有效值。
MaxInFlow	Integer	最大入带宽注意：此字段可能返回 null，表示取不到有效值。
MaxInPkg	Integer	最大入包量注意：此字段可能返回 null，表示取不到有效值。
MaxOutFlow	Integer	最大出带宽注意：此字段可能返回 null，表示取不到有效值。
MaxOutPkg	Integer	最大出包量注意：此字段可能返回 null，表示取不到有效值。
MaxNewConn	Integer	最大新建连接数注意：此字段可能返回 null，表示取不到有效值。
HTTPMaxNewConn	Integer	http最大新建连接数注意：此字段可能返回 null，表示取不到有效值。
HTTPSMaxNewConn	Integer	https最大新建连接数注意：此字段可能返回 null，表示取不到有效值。
HTTPQps	Integer	http QPS 注意：此字段可能返回 null，表示取不到有效值。
HTTPSQps	Integer	https QPS 注意：此字段可能返回 null，表示取不到有效值。
ResourceCount	Integer	集群内资源总数目
IdleResourceCount	Integer	集群内空闲资源数目注意：此字段可能返回 null，表示取不到有效值。
LoadBalanceDirectorCount	Integer	集群内转发机的数目注意：此字段可能返回 null，表示取不到有效值。
Isp	String	集群的Isp属性，如："BGP","CMCC","CUCC","CTCC","INTERNAL"。注意：此字段可能返回 null，表示取不到有效值。
ClustersZone	ClustersZone	集群所在的可用区注意：此字段可能返回 null，表示取不到有效值。
ClustersVersion	String	集群版本注意：此字段可能返回 null，表示取不到有效值。

ClusterItem

独占集群信息

被如下接口引用：CreateLoadBalancer, DescribeLoadBalancerListByCertId, DescribeLoadBalancers。

名称	类型	必选	描述
ClusterId	String	是	集群唯一ID
ClusterName	String	否	集群名称注意：此字段可能返回 null，表示取不到有效值。
Zone	String	否	集群所在可用区，如ap-guangzhou-1 注意：此字段可能返回 null，表示取不到有效值。

ClusterResource

集群内资源类型

被如下接口引用：DescribeClusterResources。

名称	类型	描述
ClusterId	String	集群唯一ID，如tgw-12345678。
Vip	String	ip地址。
LoadBalancerId	String	负载均衡唯一ID，如lb-12345678。注意：此字段可能返回 null，表示取不到有效值。
Idle	String	资源是否闲置。注意：此字段可能返回 null，表示取不到有效值。
ClusterName	String	集群名称。

ClustersZone

集群所在的可用区。

被如下接口引用：DescribeExclusiveClusters。

名称	类型	描述
MasterZone	Array of String	集群所在的主可用区。注意：此字段可能返回 null，表示取不到有效值。
SlaveZone	Array of String	集群所在的备可用区。注意：此字段可能返回 null，表示取不到有效值。

ExclusiveCluster

独占集群

被如下接口引用：CreateLoadBalancer, DescribeLoadBalancerListByCertId, DescribeLoadBalancers。

名称	类型	必选	描述
L4Clusters	Array of ClusterItem	否	4层独占集群列表注意：此字段可能返回 null，表示取不到有效值。
L7Clusters	Array of ClusterItem	否	7层独占集群列表注意：此字段可能返回 null，表示取不到有效值。
ClassicalCluster	ClusterItem	否	vpcgw集群注意：此字段可能返回 null，表示取不到有效值。

ExtraInfo

暂做保留，一般用户无需关注。

被如下接口引用：DescribeLoadBalancerListByCertId, DescribeLoadBalancers, DescribeLoadBalancersDetail。

名称	类型	描述
ZhiTong	Boolean	是否开通VIP直通注意：此字段可能返回 null，表示取不到有效值。
TgwGroupName	String	TgwGroup名称注意：此字段可能返回 null，表示取不到有效值。

Filter

过滤器条件

被如下接口引用：DescribeClusterResources, DescribeExclusiveClusters, DescribeLoadBalancers, DescribeLoadBalancersDetail, DescribeTargetGroupInstances, DescribeTargetGroupList, DescribeTargetGroups。

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

HealthCheck

健康检查信息。
注意，自定义探测相关参数目前只有少量区域灰度支持。

被如下接口引用：CreateListener, CreateRule, DescribeListeners, DescribeRewrite, ModifyListener, ModifyRule。

名称	类型	必选	描述
HealthSwitch	Integer	否	是否开启健康检查：1（开启）、0（关闭）。
TimeOut	Integer	否	健康检查的响应超时时间（仅适用于四层监听器），可选值：2~60，默认值：2，单位：秒。响应超时时间要小于检查间隔时间。注意：此字段可能返回 null，表示取不到有效值。
IntervalTime	Integer	否	健康检查探测间隔时间，默认值：5，可选值：5~300，单位：秒。注意：此字段可能返回 null，表示取不到有效值。
HealthNum	Integer	否	健康阈值，默认值：3，表示当连续探测三次健康则表示该转发正常，可选值：2~10，单位：次。注意：此字段可能返回 null，表示取不到有效值。
UnHealthNum	Integer	否	不健康阈值，默认值：3，表示当连续探测三次不健康则表示该转发异常，可选值：2~10，单位：次。注意：此字段可能返回 null，表示取不到有效值。
HttpCode	Integer	否	健康检查状态码（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。可选值：1~31，默认 31。 1 表示探测后返回值 1xx 代表健康，2 表示返回 2xx 代表健康，4 表示返回 3xx 代表健康，8 表示返回 4xx 代表健康，16 表示返回 5xx 代表健康。若希望多种返回码都可代表健康，则将相应的值相加。注意：TCP监听器的HTTP健康检查方式，只支持指定一种健康检查状态码。注意：此字段可能返回 null，表示取不到有效值。
HttpCheckPath	String	否	健康检查路径（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。注意：此字段可能返回 null，表示取不到有效值。
HttpCheckDomain	String	否	健康检查域名（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式）。注意：此字段可能返回 null，表示取不到有效值。
HttpCheckMethod	String	否	健康检查方法（仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式），默认值：HEAD，可选值HEAD或GET。注意：此字段可能返回 null，表示取不到有效值。
CheckPort	Integer	否	自定义探测相关参数。健康检查端口，默认为后端服务的端口，除非您希望指定特定端口，否则建议留空。（仅适用于TCP/UDP监听器）。注意：此字段可能返回 null，表示取不到有效值。
ContextType	String	否	自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查的输入格式，可取值：HEX或TEXT；取值为HEX时，SendContext和RecvContext的字符只能在0123456789ABCDEF中选取且长度必须是偶数位。（仅适用于TCP/UDP监听器）注意：此字段可能返回 null，表示取不到有效值。
SendContext	String	否	自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查发送的请求内容，只允许ASCII可见字符，最大长度限制500。（仅适用于TCP/UDP监听器）。注意：此字段可能返回 null，表示取不到有效值。
RecvContext	String	否	自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时，必填此字段，代表健康检查返回的结果，只允许ASCII可见字符，最大长度限制500。（仅适用于TCP/UDP监听器）。注意：此字段可能返回 null，表示取不到有效值。
CheckType	String	否	自定义探测相关参数。健康检查使用的协议：TCP
HttpVersion	String	否	自定义探测相关参数。健康检查协议CheckType的值取HTTP时，必传此字段，代表后端服务的HTTP版本：HTTP/1.0、HTTP/1.1；（仅适用于TCP监听器）注意：此字段可能返回 null，表示取不到有效值。

InternetAccessible

网络计费模式，最大出带宽

被如下接口引用：CreateLoadBalancer, DescribeLoadBalancerListByCertId, DescribeLoadBalancers, DescribeLoadBalancersDetail, ModifyLoadBalancerAttributes。

名称	类型	必选	描述
InternetChargeType	String	否	TRAFFIC_POSTPAID_BY_HOUR 按流量按小时后计费 ; BANDWIDTH_POSTPAID_BY_HOUR 按带宽按小时后计费; BANDWIDTH_PACKAGE 按带宽包计费; 注意：此字段可能返回 null，表示取不到有效值。
InternetMaxBandwidthOut	Integer	否	最大出带宽，单位Mbps，范围支持0到2048，仅对公网属性的LB生效，默认值 10 注意：此字段可能返回 null，表示取不到有效值。
BandwidthpkgSubType	String	否	带宽包的类型，如SINGLEISP 注意：此字段可能返回 null，表示取不到有效值。

LBChargePrepaid

lb实例包年包月相关配置属性

被如下接口引用：DescribeLoadBalancerListByCertId, DescribeLoadBalancers, DescribeLoadBalancersDetail。

名称	类型	必选	描述
RenewFlag	String	否	续费类型：AUTO_RENEW 自动续费， MANUAL_RENEW 手动续费注意：此字段可能返回 null，表示取不到有效值。
Period	Integer	否	购买时长，单位：月注意：此字段可能返回 null，表示取不到有效值。

Listener

监听器的信息

被如下接口引用：DescribeListeners。

名称	类型	描述
ListenerId	String	负载均衡监听器 ID
Protocol	String	监听器协议
Port	Integer	监听器端口
Certificate	CertificateOutput	监听器绑定的证书信息注意：此字段可能返回 null，表示取不到有效值。
HealthCheck	HealthCheck	监听器的健康检查信息注意：此字段可能返回 null，表示取不到有效值。
Scheduler	String	请求的调度方式注意：此字段可能返回 null，表示取不到有效值。
SessionExpireTime	Integer	会话保持时间注意：此字段可能返回 null，表示取不到有效值。
SniSwitch	Integer	是否开启SNI特性（本参数仅对于HTTPS监听器有意义）注意：此字段可能返回 null，表示取不到有效值。
Rules	Array of RuleOutput	监听器下的全部转发规则（本参数仅对于HTTP/HTTPS监听器有意义）注意：此字段可能返回 null，表示取不到有效值。
ListenerName	String	监听器的名称注意：此字段可能返回 null，表示取不到有效值。
CreateTime	String	监听器的创建时间。注意：此字段可能返回 null，表示取不到有效值。
EndPort	Integer	端口段结束端口注意：此字段可能返回 null，表示取不到有效值。
TargetType	String	后端服务器类型注意：此字段可能返回 null，表示取不到有效值。
TargetGroup	BasicTargetGroupInfo	绑定的目标组基本信息；当监听器绑定目标组时，会返回该字段注意：此字段可能返回 null，表示取不到有效值。
SessionType	String	会话保持类型。NORMAL表示默认会话保持类型。QUIC_CID 表示根据Quic Connection ID做会话保持。注意：此字段可能返回 null，表示取不到有效值。
KeepaliveEnable	Integer	是否开启长连接，1开启，0关闭，（本参数仅对于HTTP/HTTPS监听器有意义）注意：此字段可能返回 null，表示取不到有效值。
Toa	Boolean	仅支持Nat64 CLB TCP监听器注意：此字段可能返回 null，表示取不到有效值。
DeregisterTargetRst	Boolean	解绑后端目标时，是否发RST给客户端，（此参数仅对于TCP监听器有意义）。注意：此字段可能返回 null，表示取不到有效值。

ListenerBackend

监听器上绑定的后端服务的信息

被如下接口引用：DescribeTargets。

名称	类型	描述
ListenerId	String	监听器 ID
Protocol	String	监听器的协议
Port	Integer	监听器的端口
Rules	Array of RuleTargets	监听器下的规则信息（仅适用于HTTP/HTTPS监听器）注意：此字段可能返回 null，表示取不到有效值。
Targets	Array of Backend	监听器上绑定的后端服务列表（仅适用于TCP/UDP/TCP_SSL监听器）注意：此字段可能返回 null，表示取不到有效值。
EndPort	Integer	若支持端口段，则为端口段结束端口；若不支持端口段，则为0 注意：此字段可能返回 null，表示取不到有效值。

ListenerHealth

监听器的健康检查信息

被如下接口引用：DescribeTargetHealth。

名称	类型	描述
ListenerId	String	监听器ID
ListenerName	String	监听器名称注意：此字段可能返回 null，表示取不到有效值。
Protocol	String	监听器的协议
Port	Integer	监听器的端口
Rules	Array of RuleHealth	监听器的转发规则列表注意：此字段可能返回 null，表示取不到有效值。

LoadBalancer

负载均衡实例的信息

被如下接口引用：DescribeLoadBalancerListByCertId, DescribeLoadBalancers。

名称	类型	必选	描述
LoadBalancerId	String	否	负载均衡实例 ID。
LoadBalancerName	String	否	负载均衡实例的名称。
LoadBalancerType	String	否	负载均衡实例的网络类型： OPEN：公网属性， INTERNAL：内网属性。
Forward	Integer	否	负载均衡类型标识，1：负载均衡，0：传统型负载均衡。
Domain	String	否	负载均衡实例的域名，仅公网传统型负载均衡实例才提供该字段注意：此字段可能返回 null，表示取不到有效值。
LoadBalancerVips	Array of String	否	负载均衡实例的 VIP 列表。注意：此字段可能返回 null，表示取不到有效值。
Status	Integer	否	负载均衡实例的状态，包括 0：创建中，1：正常运行。注意：此字段可能返回 null，表示取不到有效值。
CreateTime	String	否	负载均衡实例的创建时间。注意：此字段可能返回 null，表示取不到有效值。
StatusTime	String	否	负载均衡实例的上次状态转换时间。注意：此字段可能返回 null，表示取不到有效值。
ProjectId	Integer	否	负载均衡实例所属的项目 ID， 0 表示默认项目。
VpcId	String	否	私有网络的 ID 注意：此字段可能返回 null，表示取不到有效值。
OpenBgp	Integer	否	高防 LB 的标识，1：高防负载均衡 0：非高防负载均衡。注意：此字段可能返回 null，表示取不到有效值。
Snat	Boolean	否	在 2016 年 12 月份之前的传统型内网负载均衡都是开启了 snat 的。注意：此字段可能返回 null，表示取不到有效值。
Isolation	Integer	否	0：表示未被隔离，1：表示被隔离。注意：此字段可能返回 null，表示取不到有效值。
Log	String	否	用户开启日志的信息，日志只有公网属性创建了 HTTP 、HTTPS 监听器的负载均衡才会有日志。注意：此字段可能返回 null，表示取不到有效值。
SubnetId	String	否	负载均衡实例所在的子网（仅对内网VPC型LB有意义）注意：此字段可能返回 null，表示取不到有效值。
Tags	Array of TagInfo	否	负载均衡实例的标签信息注意：此字段可能返回 null，表示取不到有效值。
SecureGroups	Array of String	否	负载均衡实例的安全组注意：此字段可能返回 null，表示取不到有效值。
TargetRegionInfo	TargetRegionInfo	否	负载均衡实例绑定的后端设备的基本信息注意：此字段可能返回 null，表示取不到有效值。
AnycastZone	String	否	anycast负载均衡的发布域，对于非anycast的负载均衡，此字段返回为空字符串注意：此字段可能返回 null，表示取不到有效值。
AddressIPVersion	String	否	IP版本，ipv4
NumericalVpcId	Integer	否	数值形式的私有网络 ID 注意：此字段可能返回 null，表示取不到有效值。
VipIsp	String	否	负载均衡IP地址所属的ISP 注意：此字段可能返回 null，表示取不到有效值。
MasterZone	ZoneInfo	否	主可用区注意：此字段可能返回 null，表示取不到有效值。
BackupZoneSet	Array of ZoneInfo	否	备可用区注意：此字段可能返回 null，表示取不到有效值。
IsolatedTime	String	否	负载均衡实例被隔离的时间注意：此字段可能返回 null，表示取不到有效值。
ExpireTime	String	否	负载均衡实例的过期时间，仅对预付费负载均衡生效注意：此字段可能返回 null，表示取不到有效值。
ChargeType	String	否	负载均衡实例的计费类型，PREPAID：包年包月，POSTPAID_BY_HOUR：按量计费注意：此字段可能返回 null，表示取不到有效值。
NetworkAttributes	InternetAccessible	否	负载均衡实例的网络属性注意：此字段可能返回 null，表示取不到有效值。
PrepaidAttributes	LBChargePrepaid	否	负载均衡实例的预付费相关属性注意：此字段可能返回 null，表示取不到有效值。
LogSetId	String	否	负载均衡日志服务(CLS)的日志集ID 注意：此字段可能返回 null，表示取不到有效值。
LogTopicId	String	否	负载均衡日志服务(CLS)的日志主题ID 注意：此字段可能返回 null，表示取不到有效值。
AddressIPv6	String	否	负载均衡实例的IPv6地址注意：此字段可能返回 null，表示取不到有效值。
ExtraInfo	ExtraInfo	否	暂做保留，一般用户无需关注。注意：此字段可能返回 null，表示取不到有效值。
IsDDos	Boolean	否	是否可绑定高防包注意：此字段可能返回 null，表示取不到有效值。
ConfigId	String	否	负载均衡维度的个性化配置ID 注意：此字段可能返回 null，表示取不到有效值。
LoadBalancerPassToTarget	Boolean	否	后端服务是否放通来自LB的流量注意：此字段可能返回 null，表示取不到有效值。
ExclusiveCluster	ExclusiveCluster	否	内网独占集群注意：此字段可能返回 null，表示取不到有效值。
IPv6Mode	String	否	IP地址版本为ipv6时此字段有意义， IPv6Nat64
SnatPro	Boolean	否	是否开启SnatPro。注意：此字段可能返回 null，表示取不到有效值。
SnatIps	Array of SnatIp	否	开启SnatPro负载均衡后，SnatIp列表。注意：此字段可能返回 null，表示取不到有效值。
SlaType	String	否	性能保障规格注意：此字段可能返回 null，表示取不到有效值。
IsBlock	Boolean	否	vip是否被封堵注意：此字段可能返回 null，表示取不到有效值。
IsBlockTime	String	否	封堵或解封时间注意：此字段可能返回 null，表示取不到有效值。
LocalBgp	Boolean	否	IP类型是否是本地BGP 注意：此字段可能返回 null，表示取不到有效值。
ClusterTag	String	否	7层独占标签。注意：此字段可能返回 null，表示取不到有效值。
MixIpTarget	Boolean	否	开启IPv6FullChain负载均衡7层监听器支持混绑IPv4/IPv6目标功能。注意：此字段可能返回 null，表示取不到有效值。
Zones	Array of String	否	私有网络内网负载均衡，就近接入模式下规则所落在的可用区注意：此字段可能返回 null，表示取不到有效值。
NfvInfo	String	否	CLB是否为NFV，空：不是，l7nfv：七层是NFV。注意：此字段可能返回 null，表示取不到有效值。
HealthLogSetId	String	否	负载均衡日志服务(CLS)的健康检查日志集ID 注意：此字段可能返回 null，表示取不到有效值。
HealthLogTopicId	String	否	负载均衡日志服务(CLS)的健康检查日志主题ID 注意：此字段可能返回 null，表示取不到有效值。

LoadBalancerDetail

负载均衡详细信息

被如下接口引用：DescribeLoadBalancersDetail。

名称	类型	描述
LoadBalancerId	String	负载均衡实例 ID。
LoadBalancerName	String	负载均衡实例的名称。
LoadBalancerType	String	负载均衡实例的网络类型： Public：公网属性， Private：内网属性。注意：此字段可能返回 null，表示取不到有效值。
Status	Integer	负载均衡实例的状态，包括 0：创建中，1：正常运行。注意：此字段可能返回 null，表示取不到有效值。
Address	String	负载均衡实例的 VIP 。注意：此字段可能返回 null，表示取不到有效值。
AddressIPv6	String	负载均衡实例 VIP 的IPv6地址。注意：此字段可能返回 null，表示取不到有效值。
AddressIPVersion	String	负载均衡实例IP版本，IPv4
IPv6Mode	String	负载均衡实例IPv6地址类型，IPv6Nat64
Zone	String	负载均衡实例所在可用区。注意：此字段可能返回 null，表示取不到有效值。
AddressIsp	String	负载均衡实例IP地址所属的ISP。注意：此字段可能返回 null，表示取不到有效值。
VpcId	String	负载均衡实例所属私有网络的 ID。注意：此字段可能返回 null，表示取不到有效值。
ProjectId	Integer	负载均衡实例所属的项目 ID， 0 表示默认项目。注意：此字段可能返回 null，表示取不到有效值。
CreateTime	String	负载均衡实例的创建时间。注意：此字段可能返回 null，表示取不到有效值。
ChargeType	String	负载均衡实例的计费类型。注意：此字段可能返回 null，表示取不到有效值。
NetworkAttributes	InternetAccessible	负载均衡实例的网络属性。注意：此字段可能返回 null，表示取不到有效值。
PrepaidAttributes	LBChargePrepaid	负载均衡实例的预付费相关属性。注意：此字段可能返回 null，表示取不到有效值。
ExtraInfo	ExtraInfo	暂做保留，一般用户无需关注。注意：此字段可能返回 null，表示取不到有效值。
ConfigId	String	负载均衡维度的个性化配置ID。注意：此字段可能返回 null，表示取不到有效值。
Tags	Array of TagInfo	负载均衡实例的标签信息。注意：此字段可能返回 null，表示取不到有效值。
ListenerId	String	负载均衡监听器 ID。注意：此字段可能返回 null，表示取不到有效值。
Protocol	String	监听器协议。注意：此字段可能返回 null，表示取不到有效值。
Port	Integer	监听器端口。注意：此字段可能返回 null，表示取不到有效值。
LocationId	String	转发规则的 ID。注意：此字段可能返回 null，表示取不到有效值。
Domain	String	转发规则的域名。注意：此字段可能返回 null，表示取不到有效值。
Url	String	转发规则的路径。注意：此字段可能返回 null，表示取不到有效值。
TargetId	String	后端目标ID。注意：此字段可能返回 null，表示取不到有效值。
TargetAddress	String	后端目标的IP地址。注意：此字段可能返回 null，表示取不到有效值。
TargetPort	Integer	后端目标监听端口。注意：此字段可能返回 null，表示取不到有效值。
TargetWeight	Integer	后端目标转发权重。注意：此字段可能返回 null，表示取不到有效值。
Isolation	Integer	0：表示未被隔离，1：表示被隔离。注意：此字段可能返回 null，表示取不到有效值。
SecurityGroup	Array of String	负载均衡绑定的安全组列表。注意：此字段可能返回 null，表示取不到有效值。
LoadBalancerPassToTarget	Integer	负载均衡安全组上移特性是否开启标识。注意：此字段可能返回 null，表示取不到有效值。
TargetHealth	String	后端目标健康状态。注意：此字段可能返回 null，表示取不到有效值。

LoadBalancerHealth

负载均衡实例的健康检查状态

被如下接口引用：DescribeTargetHealth。

名称	类型	描述
LoadBalancerId	String	负载均衡实例ID
LoadBalancerName	String	负载均衡实例名称注意：此字段可能返回 null，表示取不到有效值。
Listeners	Array of ListenerHealth	监听器列表注意：此字段可能返回 null，表示取不到有效值。

LoadBalancerTraffic

负载均衡流量数据。

被如下接口引用：DescribeLoadBalancerTraffic。

名称	类型	描述
LoadBalancerId	String	负载均衡ID
LoadBalancerName	String	负载均衡名字
Region	String	负载均衡所在地域
Vip	String	负载均衡的vip
OutBandwidth	Float	最大出带宽，单位：Mbps

Quota

描述配额信息，所有配额均指当前地域下的配额。

被如下接口引用：DescribeQuota。

名称	类型	描述
QuotaId	String	配额名称，取值范围： TOTAL_OPEN_CLB_QUOTA: 用户当前地域下的公网LB配额 TOTAL_INTERNAL_CLB_QUOTA: 用户当前地域下的内网LB配额 TOTAL_LISTENER_QUOTA: 一个CLB下的监听器配额 TOTAL_LISTENER_RULE_QUOTA: 一个监听器下的转发规则配额 TOTAL_TARGET_BIND_QUOTA: 一条转发规则下绑定设备配额
QuotaCurrent	Integer	当前使用数量，为 null 时表示无意义。注意：此字段可能返回 null，表示取不到有效值。
QuotaLimit	Integer	配额数量。

RewriteLocationMap

转发规则之间的重定向关系

被如下接口引用：DeleteRewrite, ManualRewrite。

名称	类型	必选	描述
SourceLocationId	String	是	源转发规则ID
TargetLocationId	String	是	重定向至的目标转发规则ID
RewriteCode	Integer	否	重定向状态码，可取值301,302,307
TakeUrl	Boolean	否	重定向是否携带匹配的url，配置RewriteCode时必填
SourceDomain	String	否	源转发的域名，必须是SourceLocationId对应的域名，配置RewriteCode时必填

RewriteTarget

重定向目标的信息

被如下接口引用：DescribeListeners, DescribeRewrite。

名称	类型	描述
TargetListenerId	String	重定向目标的监听器ID 注意：此字段可能返回 null，表示无重定向。注意：此字段可能返回 null，表示取不到有效值。
TargetLocationId	String	重定向目标的转发规则ID 注意：此字段可能返回 null，表示无重定向。注意：此字段可能返回 null，表示取不到有效值。
RewriteCode	Integer	重定向状态码注意：此字段可能返回 null，表示取不到有效值。
TakeUrl	Boolean	重定向是否携带匹配的url 注意：此字段可能返回 null，表示取不到有效值。
RewriteType	String	重定向类型，Manual: 手动重定向，Auto: 自动重定向注意：此字段可能返回 null，表示取不到有效值。

RsWeightRule

修改节点权重的数据类型

被如下接口引用：BatchModifyTargetWeight。

名称	类型	必选	描述
ListenerId	String	是	负载均衡监听器 ID。
Targets	Array of Target	是	要修改权重的后端机器列表。
LocationId	String	否	转发规则的ID，七层规则时需要此参数，4层规则不需要。
Domain	String	否	目标规则的域名，提供LocationId参数时本参数不生效。
Url	String	否	目标规则的URL，提供LocationId参数时本参数不生效。
Weight	Integer	否	后端服务修改后的转发权重，取值范围：[0，100]。此参数的优先级低于前述Target中的Weight参数，即最终的权重值以Target中的Weight参数值为准，仅当Target中的Weight参数为空时，才以RsWeightRule中的Weight参数为准。

RuleHealth

一条转发规则的健康检查状态

被如下接口引用：DescribeTargetHealth。

名称	类型	描述
LocationId	String	转发规则ID
Domain	String	转发规则的域名注意：此字段可能返回 null，表示取不到有效值。
Url	String	转发规则的Url 注意：此字段可能返回 null，表示取不到有效值。
Targets	Array of TargetHealth	本规则上绑定的后端服务的健康检查状态注意：此字段可能返回 null，表示取不到有效值。

RuleInput

HTTP/HTTPS转发规则（输入）

被如下接口引用：CreateRule。

名称	类型	必选	描述
Domain	String	是	转发规则的域名。长度限制为：1~80。
Url	String	是	转发规则的路径。长度限制为：1~200。
SessionExpireTime	Integer	否	会话保持时间。设置为0表示关闭会话保持，开启会话保持可取值30~3600，单位：秒。
HealthCheck	HealthCheck	否	健康检查信息。详情请参见：健康检查
Certificate	CertificateInput	否	证书信息
Scheduler	String	否	规则的请求转发方式，可选值：WRR、LEAST_CONN、IP_HASH 分别表示按权重轮询、最小连接数、按IP哈希，默认为 WRR。
ForwardType	String	否	负载均衡与后端服务之间的转发协议，目前支持 HTTP/HTTPS/TRPC
DefaultServer	Boolean	否	是否将该域名设为默认域名，注意，一个监听器下只能设置一个默认域名。
Http2	Boolean	否	是否开启Http2，注意，只有HTTPS域名才能开启Http2。
TargetType	String	否	后端目标类型，NODE表示绑定普通节点，TARGETGROUP表示绑定目标组
TrpcCallee	String	否	TRPC被调服务器路由，ForwardType为TRPC时必填
TrpcFunc	String	否	TRPC调用服务接口，ForwardType为TRPC时必填
Quic	Boolean	否	是否开启QUIC，注意，只有HTTPS域名才能开启QUIC

RuleOutput

HTTP/HTTPS监听器的转发规则（输出）

被如下接口引用：DescribeListeners, DescribeRewrite。

名称	类型	描述
LocationId	String	转发规则的 ID
Domain	String	转发规则的域名。注意：此字段可能返回 null，表示取不到有效值。
Url	String	转发规则的路径。注意：此字段可能返回 null，表示取不到有效值。
SessionExpireTime	Integer	会话保持时间
HealthCheck	HealthCheck	健康检查信息注意：此字段可能返回 null，表示取不到有效值。
Certificate	CertificateOutput	证书信息注意：此字段可能返回 null，表示取不到有效值。
Scheduler	String	规则的请求转发方式
ListenerId	String	转发规则所属的监听器 ID
RewriteTarget	RewriteTarget	转发规则的重定向目标信息注意：此字段可能返回 null，表示取不到有效值。
HttpGzip	Boolean	是否开启gzip
BeAutoCreated	Boolean	转发规则是否为自动创建
DefaultServer	Boolean	是否作为默认域名
Http2	Boolean	是否开启Http2
ForwardType	String	负载均衡与后端服务之间的转发协议
CreateTime	String	转发规则的创建时间
TargetType	String	后端服务器类型
TargetGroup	BasicTargetGroupInfo	绑定的目标组基本信息；当规则绑定目标组时，会返回该字段注意：此字段可能返回 null，表示取不到有效值。
WafDomainId	String	WAF实例ID 注意：此字段可能返回 null，表示取不到有效值。
TrpcCallee	String	TRPC被调服务器路由，ForwardType为TRPC时有效注意：此字段可能返回 null，表示取不到有效值。
TrpcFunc	String	TRPC调用服务接口，ForwardType为TRPC时有效注意：此字段可能返回 null，表示取不到有效值。
QuicStatus	String	QUIC状态注意：此字段可能返回 null，表示取不到有效值。

RuleTargets

HTTP/HTTPS监听器下的转发规则绑定的后端服务信息

被如下接口引用：DescribeTargets。

名称	类型	描述
LocationId	String	转发规则的 ID
Domain	String	转发规则的域名
Url	String	转发规则的路径。
Targets	Array of Backend	后端服务的信息注意：此字段可能返回 null，表示取不到有效值。

SnatIp

SnatIp的信息结构

被如下接口引用：CreateLoadBalancer, CreateLoadBalancerSnatIps, DescribeLoadBalancerListByCertId, DescribeLoadBalancers。

名称	类型	必选	描述
SubnetId	String	是	私有网络子网的唯一性id，如subnet-12345678
Ip	String	否	IP地址，如192.168.0.1

TagInfo

负载均衡的标签信息

被如下接口引用：CreateLoadBalancer, DescribeLoadBalancerListByCertId, DescribeLoadBalancers, DescribeLoadBalancersDetail。

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

Target

转发目标，即绑定在负载均衡上的后端服务

被如下接口引用：BatchModifyTargetWeight, DeregisterTargets, ModifyTargetPort, ModifyTargetWeight, RegisterTargets。

名称	类型	必选	描述
Port	Integer	是	后端服务的监听端口。注意：绑定CVM（云服务器）或ENI（弹性网卡）时必传此参数注意：此字段可能返回 null，表示取不到有效值。
Type	String	否	后端服务的类型，可取：CVM（云服务器）、ENI（弹性网卡）；作为入参时，目前本参数暂不生效。注意：此字段可能返回 null，表示取不到有效值。
InstanceId	String	否	绑定CVM时需要传入此参数，代表CVM的唯一 ID，可通过 DescribeInstances 接口返回字段中的 InstanceId 字段获取。表示绑定主网卡主IP。注意：参数 InstanceId、EniIp 只能传入一个且必须传入一个。注意：此字段可能返回 null，表示取不到有效值。
Weight	Integer	否	后端服务修改后的转发权重，取值范围：[0, 100]，默认为 10。此参数的优先级高于RsWeightRule中的Weight参数，即最终的权重值以此Weight参数值为准，仅当此Weight参数为空时，才以RsWeightRule中的Weight参数为准。
EniIp	String	否	绑定IP时需要传入此参数，支持弹性网卡的IP和其他内网IP，如果是弹性网卡则必须先绑定至CVM，然后才能绑定到负载均衡实例。注意：参数 InstanceId、EniIp 只能传入一个且必须传入一个。如果绑定双栈IPV6子机，必须传该参数。注意：此字段可能返回 null，表示取不到有效值。

TargetGroupAssociation

规则与目标组的关联关系

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

名称	类型	必选	描述
LoadBalancerId	String	是	负载均衡ID
ListenerId	String	是	监听器ID
TargetGroupId	String	是	目标组ID
LocationId	String	否	转发规则ID

TargetGroupBackend

目标组绑定的后端服务器

被如下接口引用：DescribeTargetGroupInstances。

名称	类型	描述
TargetGroupId	String	目标组ID
Type	String	后端服务的类型，可取：CVM、ENI（即将支持）
InstanceId	String	后端服务的唯一 ID
Port	Integer	后端服务的监听端口
Weight	Integer	后端服务的转发权重，取值范围：[0, 100]，默认为 10。
PublicIpAddresses	Array of String	后端服务的外网 IP 注意：此字段可能返回 null，表示取不到有效值。
PrivateIpAddresses	Array of String	后端服务的内网 IP 注意：此字段可能返回 null，表示取不到有效值。
InstanceName	String	后端服务的实例名称注意：此字段可能返回 null，表示取不到有效值。
RegisteredTime	Timestamp	后端服务被绑定的时间注意：此字段可能返回 null，表示取不到有效值。
EniId	String	弹性网卡唯一ID 注意：此字段可能返回 null，表示取不到有效值。
ZoneId	Integer	后端服务的可用区ID 注意：此字段可能返回 null，表示取不到有效值。

TargetGroupInfo

目标组信息

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

名称	类型	描述
TargetGroupId	String	目标组ID
VpcId	String	目标组的vpcid
TargetGroupName	String	目标组的名字
Port	Integer	目标组的默认端口注意：此字段可能返回 null，表示取不到有效值。
CreatedTime	Timestamp	目标组的创建时间
UpdatedTime	Timestamp	目标组的修改时间
AssociatedRule	Array of AssociationItem	关联到的规则数组注意：此字段可能返回 null，表示取不到有效值。

TargetGroupInstance

目标组实例

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

名称	类型	必选	描述
BindIP	String	是	目标组实例的内网IP
Port	Integer	是	目标组实例的端口
Weight	Integer	否	目标组实例的权重
NewPort	Integer	否	目标组实例的新端口

TargetHealth

描述一个Target的健康信息

被如下接口引用：DescribeTargetHealth。

名称	类型	描述
IP	String	Target的内网IP
Port	Integer	Target绑定的端口
HealthStatus	Boolean	当前健康状态，true：健康，false：不健康（包括尚未开始探测、探测中、状态异常等几种状态）。只有处于健康状态（且权重大于0），负载均衡才会向其转发流量。
TargetId	String	Target的实例ID，如 ins-12345678
HealthStatusDetial	String	当前健康状态的详细信息。如：Alive、Dead、Unknown。Alive状态为健康，Dead状态为异常，Unknown状态包括尚未开始探测、探测中、状态未知。

TargetRegionInfo

负载均衡实例所绑定的后端服务的信息，包括所属地域、所属网络。

被如下接口引用：DescribeLoadBalancerListByCertId, DescribeLoadBalancers, ModifyLoadBalancerAttributes。

名称	类型	必选	描述
Region	String	是	Target所属地域，如 ap-guangzhou
VpcId	String	是	Target所属网络，私有网络格式如 vpc-abcd1234，如果是基础网络，则为"0"

ZoneInfo

可用区相关信息

被如下接口引用：DescribeLoadBalancerListByCertId, DescribeLoadBalancers。

名称	类型	描述
ZoneId	Integer	可用区数值形式的唯一ID，如：100001 注意：此字段可能返回 null，表示取不到有效值。
Zone	String	可用区字符串形式的唯一ID，如：ap-guangzhou-1 注意：此字段可能返回 null，表示取不到有效值。
ZoneName	String	可用区名称，如：广州一区注意：此字段可能返回 null，表示取不到有效值。
ZoneRegion	String	可用区所属地域，如：ap-guangzhou 注意：此字段可能返回 null，表示取不到有效值。
LocalZone	Boolean	可用区是否是LocalZone可用区，如：false 注意：此字段可能返回 null，表示取不到有效值。

上一篇: 通过后端主机反向查找其绑定的传统型负载均衡下一篇: 错误码

产品动态

产品简介

购买指南

快速入门

操作指南

最佳实践

运维指南

API 文档

视频专区

常见问题

公告

服务等级协议

词汇表

本页目录：

AssociationItem

Backend

BasicTargetGroupInfo

BatchTarget

BlockedIP

CertIdRelatedWithLoadBalancers

CertificateInput

CertificateOutput

ClassicalHealth

ClassicalListener

ClassicalLoadBalancerInfo

ClassicalTarget

ClassicalTargetInfo

Cluster

ClusterItem

ClusterResource

ClustersZone

ExclusiveCluster

ExtraInfo

Filter

HealthCheck

InternetAccessible

LBChargePrepaid

Listener

ListenerBackend

ListenerHealth

LoadBalancer

LoadBalancerDetail

LoadBalancerHealth

LoadBalancerTraffic

Quota

RewriteLocationMap

RewriteTarget

RsWeightRule

RuleHealth

RuleInput

RuleOutput

RuleTargets

SnatIp

TagInfo

Target

TargetGroupAssociation

TargetGroupBackend

TargetGroupInfo

TargetGroupInstance

TargetHealth

TargetRegionInfo

ZoneInfo