有奖捉虫:云通信与企业服务文档专题,速来> HOT

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、CCN
示例值:CVM
InstanceId String 后端服务的唯一 ID,如 ins-abcd1234
示例值:ins-abcd1234
Port Integer 后端服务的监听端口
示例值:80
Weight Integer 后端服务的转发权重,取值范围:[0, 100],默认为 10。
示例值:10
PublicIpAddresses Array of String 后端服务的外网 IP
注意:此字段可能返回 null,表示取不到有效值。
示例值:1.1.1.1
PrivateIpAddresses Array of String 后端服务的内网 IP
注意:此字段可能返回 null,表示取不到有效值。
示例值:10.0.0.1
InstanceName String 后端服务的实例名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:test-cvm
RegisteredTime String 后端服务被绑定的时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-12-29 14:38:50
EniId String 弹性网卡唯一ID,如 eni-1234abcd
注意:此字段可能返回 null,表示取不到有效值。
示例值:eni-1234abcd
Tag String 标签。
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx

BasicTargetGroupInfo

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

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

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

BatchTarget

批量绑定类型

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

名称 类型 必选 描述
ListenerId String 监听器 ID。
示例值:lbl-2gas****
Port Integer 绑定端口。
示例值:80
InstanceId String 子机 ID。表示绑定主网卡主 IP。
示例值:ins-1vfj****
EniIp String 绑定 IP 时需要传入此参数,支持弹性网卡的 IP 和其他内网 IP,如果是弹性网卡则必须先绑定至CVM,然后才能绑定到负载均衡实例。
注意:参数 InstanceId、EniIp 只能传入一个且必须传入一个。如果绑定双栈IPV6子机,必须传该参数。
示例值:10.0.X.X
Weight Integer 子机权重,范围[0, 100]。绑定时如果不存在,则默认为10。
示例值:10
LocationId String 七层规则 ID。7层负载均衡该参数必填
示例值:lbl-4apy****
Tag String 标签。
示例值:xxx

BindDetailItem

绑定关系,包含监听器名字、协议、url、vport。

被如下接口引用:DescribeCustomizedConfigAssociateList。

名称 类型 描述
LoadBalancerId String 配置绑定的CLB ID
ListenerId String 配置绑定的监听器ID
注意:此字段可能返回 null,表示取不到有效值。
Domain String 配置绑定的域名
注意:此字段可能返回 null,表示取不到有效值。
LocationId String 配置绑定的规则
注意:此字段可能返回 null,表示取不到有效值。
ListenerName String 监听器名字
注意:此字段可能返回 null,表示取不到有效值。
Protocol String 监听器协议
注意:此字段可能返回 null,表示取不到有效值。
Vport Integer 监听器端口
注意:此字段可能返回 null,表示取不到有效值。
Url String location的url
注意:此字段可能返回 null,表示取不到有效值。
UconfigId String 配置ID
注意:此字段可能返回 null,表示取不到有效值。

BlockedIP

加入了12306黑名单的IP

被如下接口引用:DescribeBlockIPList。

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

CertIdRelatedWithLoadBalancers

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

被如下接口引用:DescribeLoadBalancerListByCertId。

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

CertInfo

证书信息

被如下接口引用:CreateListener, ModifyDomainAttributes, ModifyListener。

名称 类型 必选 描述
CertId String 证书 ID,如果不填写此项则必须上传证书内容,包括CertName, CertContent,若为服务端证书必须包含CertKey。
示例值:zFzZAAIr
CertName String 上传证书的名称,如果没有 CertId,则此项必传。
示例值:tes-cert
CertContent String 上传证书的公钥;如果没有 CertId,则此项必传。
示例值: -----BEGIN CERTIFICATE-----
CertKey String 上传服务端证书的私钥;如果没有 CertId,则此项必传。
示例值:-----BEGIN RSA PRIVATE KEY-----

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:双向认证
示例值:UNIDIRECTIONAL
CertId String 服务端证书的ID。
示例值:ALZ****p
CertCaId String 客户端证书的 ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:4Ih****6
ExtCertIds Array of 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
示例值:stgw-clclwcxx
ClusterName String 集群名称
示例值:Guanzhaou-hxy-MS-CLB
ClusterType String 集群类型,如TGW,STGW,VPCGW
示例值:STGW
ClusterTag String 集群标签,只有TGW/STGW集群有标签
注意:此字段可能返回 null,表示取不到有效值。
示例值:TEST-FOR-XXX
Zone String 集群所在可用区,如ap-guangzhou-1
示例值:ap-guangzhou-1
Network String 集群网络类型,如Public,Private
示例值:Public
MaxConn Integer 最大连接数(个/秒)
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
MaxInFlow Integer 最大入带宽Mbps
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
MaxInPkg Integer 最大入包量(个/秒)
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
MaxOutFlow Integer 最大出带宽Mbps
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
MaxOutPkg Integer 最大出包量(个/秒)
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
MaxNewConn Integer 最大新建连接数(个/秒)
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
HTTPMaxNewConn Integer http最大新建连接数(个/秒)
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
HTTPSMaxNewConn Integer https最大新建连接数(个/秒)
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
HTTPQps Integer http QPS
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
HTTPSQps Integer https QPS
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ResourceCount Integer 集群内资源总数目
示例值:0
IdleResourceCount Integer 集群内空闲资源数目
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
LoadBalanceDirectorCount Integer 集群内转发机的数目
注意:此字段可能返回 null,表示取不到有效值。
示例值:4
Isp String 集群的Isp属性,如:"BGP","CMCC","CUCC","CTCC","INTERNAL"。
注意:此字段可能返回 null,表示取不到有效值。
示例值:BGP
ClustersZone ClustersZone 集群所在的可用区
注意:此字段可能返回 null,表示取不到有效值。
ClustersVersion String 集群版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
DisasterRecoveryType String 集群容灾类型,如SINGLE-ZONE,DISASTER-RECOVERY,MUTUAL-DISASTER-RECOVERY
注意:此字段可能返回 null,表示取不到有效值。
示例值:SINGLE-ZONE
Egress String 网络出口
注意:此字段可能返回 null,表示取不到有效值。
示例值:center_egress2
IPVersion String IP版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:IPv4

ClusterItem

独占集群信息

被如下接口引用:CloneLoadBalancer, CreateLoadBalancer, MigrateClassicalLoadBalancers。

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

ClusterResource

集群内资源类型

被如下接口引用:DescribeClusterResources。

名称 类型 描述
ClusterId String 集群唯一ID,如tgw-12345678。
示例值:tgw-12345678
Vip String ip地址。
示例值:1.1.1.2
LoadBalancerId String 负载均衡唯一ID,如lb-12345678。
注意:此字段可能返回 null,表示取不到有效值。
示例值:lb-12345678
Idle String 资源是否闲置。
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
ClusterName String 集群名称。
示例值:cluster-1
Isp String 集群的Isp属性,如:"BGP","CMCC","CUCC","CTCC","INTERNAL"。
注意:此字段可能返回 null,表示取不到有效值。
示例值:BGP,CMCC
ClustersZone ClustersZone 集群所在的可用区
注意:此字段可能返回 null,表示取不到有效值。

ClustersZone

集群所在的可用区。

被如下接口引用:DescribeClusterResources, DescribeExclusiveClusters。

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

ConfigListItem

配置内容

被如下接口引用:DescribeCustomizedConfigList。

名称 类型 描述
UconfigId String 配置ID
ConfigType String 配置类型
ConfigName String 配置名字
注意:此字段可能返回 null,表示取不到有效值。
ConfigContent String 配置内容
CreateTimestamp String 增加配置时间
UpdateTimestamp String 修改配置时间

CrossTargets

跨域2.0云联网下子机和网卡信息

被如下接口引用:DescribeCrossTargets。

名称 类型 描述
LocalVpcId String 本地私有网络ID,即负载均衡的VpcId。
示例值:vpc-1ywq****
VpcId String 子机或网卡所属的私有网络ID。
示例值:vpc-12sd****
IP String 子机或网卡的IP地址
示例值:172.16.xxx.xxx
VpcName String 子机或网卡所属的私有网络名称。
示例值:test-vpc
EniId String 子机的网卡ID。
示例值:eni-hsc9****
InstanceId String 子机实例ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:ins-cxyp****
InstanceName String 子机实例名称。
注意:此字段可能返回 null,表示取不到有效值。
示例值:test-name
Region String 子机或者网卡所属的地域。
示例值:ap-shanghai

ExclusiveCluster

独占集群

被如下接口引用:CloneLoadBalancer, CreateLoadBalancer, DescribeLoadBalancerListByCertId, DescribeLoadBalancers, MigrateClassicalLoadBalancers。

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

ExtraInfo

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

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

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

Filter

过滤器条件

被如下接口引用:DescribeClusterResources, DescribeCrossTargets, DescribeCustomizedConfigList, DescribeExclusiveClusters, DescribeLoadBalancers, DescribeLoadBalancersDetail, DescribeResources, DescribeTargetGroupInstances, DescribeTargetGroupList, DescribeTargetGroups, DescribeTargets。

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

FunctionInfo

SCF云函数(Serverless Cloud Function)相关信息。

被如下接口引用:DeregisterFunctionTargets, ModifyFunctionTargets, RegisterFunctionTargets。

名称 类型 必选 描述
FunctionNamespace String 函数命名空间
FunctionName String 函数名称
FunctionQualifier String 函数的版本名称或别名
FunctionQualifierType String 标识 FunctionQualifier 参数的类型,可取值: VERSION(版本)、ALIAS(别名)
注意:此字段可能返回 null,表示取不到有效值。

FunctionTarget

SCF云函数(Serverless Cloud Function)作为后端服务

被如下接口引用:DeregisterFunctionTargets, DescribeTargets, ModifyFunctionTargets, RegisterFunctionTargets。

名称 类型 必选 描述
Function FunctionInfo 云函数相关信息
注意:此字段可能返回 null,表示取不到有效值。
Weight Integer 权重

HealthCheck

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

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

名称 类型 必选 描述
HealthSwitch Integer 是否开启健康检查:1(开启)、0(关闭)。
示例值:0
TimeOut Integer 健康检查的响应超时时间,可选值:2~60,默认值:2,单位:秒。响应超时时间要小于检查间隔时间。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
IntervalTime Integer 健康检查探测间隔时间,默认值:5,IPv4 CLB实例的取值范围为:2-300,IPv6 CLB 实例的取值范围为:5-300。单位:秒。
说明:部分老旧 IPv4 CLB实例的取值范围为:5-300。
注意:此字段可能返回 null,表示取不到有效值。
示例值:5
HealthNum Integer 健康阈值,默认值:3,表示当连续探测三次健康则表示该转发正常,可选值:2~10,单位:次。
注意:此字段可能返回 null,表示取不到有效值。
示例值:3
UnHealthNum Integer 不健康阈值,默认值:3,表示当连续探测三次不健康则表示该转发异常,可选值:2~10,单位:次。
注意:此字段可能返回 null,表示取不到有效值。
示例值:3
HttpCode Integer 健康检查状态码(仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式)。可选值:1~31,默认 31。
1 表示探测后返回值 1xx 代表健康,2 表示返回 2xx 代表健康,4 表示返回 3xx 代表健康,8 表示返回 4xx 代表健康,16 表示返回 5xx 代表健康。若希望多种返回码都可代表健康,则将相应的值相加。
注意:此字段可能返回 null,表示取不到有效值。
示例值:8
HttpCheckPath String 健康检查路径(仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式)。
注意:此字段可能返回 null,表示取不到有效值。
示例值:/xxx
HttpCheckDomain String 健康检查域名(仅适用于HTTP/HTTPS监听器和TCP监听器的HTTP健康检查方式。针对TCP监听器,当使用HTTP健康检查方式时,该参数为必填项)。
注意:此字段可能返回 null,表示取不到有效值。
示例值:www.xxxx.com
HttpCheckMethod String 健康检查方法(仅适用于HTTP/HTTPS转发规则、TCP监听器的HTTP健康检查方式),默认值:HEAD,可选值HEAD或GET。
注意:此字段可能返回 null,表示取不到有效值。
示例值:HEAD
CheckPort Integer 自定义探测相关参数。健康检查端口,默认为后端服务的端口,除非您希望指定特定端口,否则建议留空。(仅适用于TCP/UDP监听器)。
注意:此字段可能返回 null,表示取不到有效值。
示例值:8000
ContextType String 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时,必填此字段,代表健康检查的输入格式,可取值:HEX或TEXT;取值为HEX时,SendContext和RecvContext的字符只能在0123456789ABCDEF中选取且长度必须是偶数位。(仅适用于TCP/UDP监听器)
注意:此字段可能返回 null,表示取不到有效值。
示例值:TEXT
SendContext String 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时,必填此字段,代表健康检查发送的请求内容,只允许ASCII可见字符,最大长度限制500。(仅适用于TCP/UDP监听器)。
注意:此字段可能返回 null,表示取不到有效值。
示例值:request-info
RecvContext String 自定义探测相关参数。健康检查协议CheckType的值取CUSTOM时,必填此字段,代表健康检查返回的结果,只允许ASCII可见字符,最大长度限制500。(仅适用于TCP/UDP监听器)。
注意:此字段可能返回 null,表示取不到有效值。
示例值:response-info
CheckType String 健康检查使用的协议。取值 TCP | HTTP | HTTPS | GRPC | PING | CUSTOM,UDP监听器支持PING/CUSTOM,TCP监听器支持TCP/HTTP/CUSTOM,TCP_SSL/QUIC监听器支持TCP/HTTP,HTTP规则支持HTTP/GRPC,HTTPS规则支持HTTP/HTTPS/GRPC。HTTP监听器默认值为HTTP;TCP、TCP_SSL、QUIC监听器默认值为TCP;UDP监听器默认为PING;HTTPS监听器的CheckType默认值与后端转发协议一致。
注意:此字段可能返回 null,表示取不到有效值。
示例值:HTTP
HttpVersion String HTTP版本。健康检查协议CheckType的值取HTTP时,必传此字段,代表后端服务的HTTP版本:HTTP/1.0、HTTP/1.1;(仅适用于TCP监听器)
注意:此字段可能返回 null,表示取不到有效值。
示例值:HTTP/1.1
SourceIpType Integer 健康检查源IP类型:0(使用LB的VIP作为源IP),1(使用100.64网段IP作为源IP),默认值:0
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ExtendedCode String GRPC健康检查状态码(仅适用于后端转发协议为GRPC的规则)。默认值为 12,可输入值为数值、多个数值、或者范围,例如 20 或 20,25 或 0-99
注意:此字段可能返回 null,表示取不到有效值。
示例值:12

IdleLoadBalancer

闲置实例。

被如下接口引用:DescribeIdleLoadBalancers。

名称 类型 描述
LoadBalancerId String 负载均衡ID
示例值:lb-abcedf
LoadBalancerName String 负载均衡名字
示例值:test-name
Region String 负载均衡所在地域
示例值:ap-guangzhou
Vip String 负载均衡的vip
示例值:1.1.1.1
IdleReason String 闲置原因。NO_RULES:没有规则,NO_RS:有规则没有绑定子机。
示例值:NO_RULES
Status Integer 负载均衡实例的状态,包括
0:创建中,1:正常运行。
示例值:1
Forward Integer 负载均衡类型标识,1:负载均衡,0:传统型负载均衡。
示例值:1
Domain String 负载均衡域名
注意:此字段可能返回 null,表示取不到有效值。
示例值:lb-xxxxx.tencentclb.com

InternetAccessible

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

被如下接口引用:CloneLoadBalancer, CreateLoadBalancer, DescribeLoadBalancerListByCertId, DescribeLoadBalancers, DescribeLoadBalancersDetail, InquiryPriceCreateLoadBalancer, InquiryPriceModifyLoadBalancer, ModifyLoadBalancerAttributes。

名称 类型 必选 描述
InternetChargeType String TRAFFIC_POSTPAID_BY_HOUR 按流量按小时后计费 ; BANDWIDTH_POSTPAID_BY_HOUR 按带宽按小时后计费; BANDWIDTH_PACKAGE 按带宽包计费;BANDWIDTH_PREPAID按带宽预付费。
注意:此字段可能返回 null,表示取不到有效值。
示例值:BANDWIDTH_POSTPAID_BY_HOUR
InternetMaxBandwidthOut Integer 最大出带宽,单位Mbps,仅对公网属性的共享型、性能容量型和独占型 CLB 实例、以及内网属性的性能容量型 CLB 实例生效。
- 对于公网属性的共享型和独占型 CLB 实例,最大出带宽的范围为1Mbps-2048Mbps。
- 对于公网属性和内网属性的性能容量型 CLB实例,最大出带宽的范围为1Mbps-61440Mbps。
(调用CreateLoadBalancer创建LB时不指定此参数则设置为默认值10Mbps。此上限可调整)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
BandwidthpkgSubType String 带宽包的类型,如SINGLEISP(单线)、BGP(多线)。
注意:此字段可能返回 null,表示取不到有效值。
示例值:SINGLEISP

ItemPrice

描述了单项的价格信息

被如下接口引用:InquiryPriceCreateLoadBalancer, InquiryPriceModifyLoadBalancer, InquiryPriceRefundLoadBalancer, InquiryPriceRenewLoadBalancer。

名称 类型 描述
UnitPrice Float 后付费单价,单位:元。
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
ChargeUnit String 后续计价单元,可取值范围:
HOUR:表示计价单元是按每小时来计算。当前涉及该计价单元的场景有:实例按小时后付费(POSTPAID_BY_HOUR)、带宽按小时后付费(BANDWIDTH_POSTPAID_BY_HOUR);
GB:表示计价单元是按每GB来计算。当前涉及该计价单元的场景有:流量按小时后付费(TRAFFIC_POSTPAID_BY_HOUR)。
注意:此字段可能返回 null,表示取不到有效值。
示例值:HOUR
OriginalPrice Float 预支费用的原价,单位:元。
注意:此字段可能返回 null,表示取不到有效值。
示例值:50
DiscountPrice Float 预支费用的折扣价,单位:元。
注意:此字段可能返回 null,表示取不到有效值。
示例值:50
UnitPriceDiscount Float 后付费的折扣单价,单位:元
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
Discount Float 折扣,如20.0代表2折。
注意:此字段可能返回 null,表示取不到有效值。
示例值:100

LBChargePrepaid

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

被如下接口引用:DescribeLoadBalancerListByCertId, DescribeLoadBalancers, DescribeLoadBalancersDetail, InquiryPriceCreateLoadBalancer, InquiryPriceRenewLoadBalancer。

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

LBItem

反查Lb绑定关系。

被如下接口引用:DescribeLBListeners。

名称 类型 描述
LoadBalancerId String lb的字符串id
Vip String lb的vip
Listeners Array of ListenerItem 监听器规则
Region String LB所在地域

LbRsItem

查询类型

被如下接口引用:DescribeLBListeners。

名称 类型 必选 描述
VpcId String vpc的字符串id,只支持字符串id。
示例值:vpc-xxxxx
PrivateIp String 需要查询后端的内网ip,可以是cvm和弹性网卡。
示例值:1.1.1.1

LbRsTargets

反查结果数据类型。

被如下接口引用:DescribeLBListeners。

名称 类型 描述
Type String 内网ip类型。“cvm”或“eni”
PrivateIp String 后端实例的内网ip。
Port Integer 绑定后端实例的端口。
VpcId Integer rs的vpcId
注意:此字段可能返回 null,表示取不到有效值。
Weight Integer rs的权重
注意:此字段可能返回 null,表示取不到有效值。

Listener

监听器的信息

被如下接口引用:DescribeListeners。

名称 类型 描述
ListenerId String 负载均衡监听器 ID
示例值:lbl-odt45qxx
Protocol String 监听器协议
示例值:HTTP
Port Integer 监听器端口
示例值:80
Certificate CertificateOutput 监听器绑定的证书信息
注意:此字段可能返回 null,表示取不到有效值。
HealthCheck HealthCheck 监听器的健康检查信息
注意:此字段可能返回 null,表示取不到有效值。
Scheduler String 请求的调度方式。 WRR、LEAST_CONN、IP_HASH分别表示按权重轮询、最小连接数、IP Hash。
注意:此字段可能返回 null,表示取不到有效值。
示例值:WRR
SessionExpireTime Integer 会话保持时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
SniSwitch Integer 是否开启SNI特性,1:表示开启,0:表示不开启(本参数仅对于HTTPS监听器有意义)
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Rules Array of RuleOutput 监听器下的全部转发规则(本参数仅对于HTTP/HTTPS监听器有意义)
注意:此字段可能返回 null,表示取不到有效值。
ListenerName String 监听器的名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:Name
CreateTime String 监听器的创建时间。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-03-01 15:27:04
EndPort Integer 端口段结束端口
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
TargetType String 后端服务器类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:NODE
TargetGroup BasicTargetGroupInfo 绑定的目标组基本信息;当监听器绑定目标组时,会返回该字段
注意:此字段可能返回 null,表示取不到有效值。
SessionType String 会话保持类型。NORMAL表示默认会话保持类型。QUIC_CID 表示根据Quic Connection ID做会话保持。
注意:此字段可能返回 null,表示取不到有效值。
示例值:NORMAL
KeepaliveEnable Integer 是否开启长连接,1开启,0关闭,(本参数仅对于HTTP/HTTPS监听器有意义)
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Toa Boolean 仅支持Nat64 CLB TCP监听器
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
DeregisterTargetRst Boolean 解绑后端目标时,是否发RST给客户端,(此参数仅对于TCP监听器有意义)。
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
AttrFlags Array of String 监听器的属性
注意:此字段可能返回 null,表示取不到有效值。
示例值:Stop
TargetGroupList Array of BasicTargetGroupInfo 绑定的目标组列表
注意:此字段可能返回 null,表示取不到有效值。
MaxConn Integer 监听器最大连接数,-1表示监听器维度不限速。
注意:此字段可能返回 null,表示取不到有效值。
示例值:-1
MaxCps Integer 监听器最大新增连接数,-1表示监听器维度不限速。
注意:此字段可能返回 null,表示取不到有效值。
示例值:-1
IdleConnectTimeout Integer 空闲连接超时时间,仅支持TCP监听器。默认值:900;共享型实例和独占型实例取值范围:300~900,性能容量型实例取值范围:300~1980。
注意:此字段可能返回 null,表示取不到有效值。
示例值:900
RescheduleInterval Integer 调度时间。触发强制重新调度后,长连接将会在设置的调度时间内断开并完成重新分配
注意:此字段可能返回 null,表示取不到有效值。
示例值:600

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,表示取不到有效值。

ListenerItem

反查监听器类型

被如下接口引用:DescribeLBListeners。

名称 类型 描述
ListenerId String 监听器ID
Protocol String 监听器协议
Port Integer 监听器端口
Rules Array of RulesItems 绑定规则
注意:此字段可能返回 null,表示取不到有效值。
Targets Array of LbRsTargets 四层绑定对象
注意:此字段可能返回 null,表示取不到有效值。
EndPort Integer 端口段监听器的结束端口
注意:此字段可能返回 null,表示取不到有效值。

LoadBalancer

负载均衡实例的信息

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

名称 类型 必选 描述
LoadBalancerId String 负载均衡实例 ID。
示例值:lb-fwzzxxxx
LoadBalancerName String 负载均衡实例的名称。
示例值:Name
LoadBalancerType String 负载均衡实例的网络类型:
OPEN:公网属性, INTERNAL:内网属性。
示例值:OPEN
Forward Integer 负载均衡类型标识,1:负载均衡,0:传统型负载均衡。
示例值:1
Domain String 负载均衡实例的域名,仅公网传统型和域名型负载均衡实例才提供该字段。逐步下线中,建议用LoadBalancerDomain替代。
注意:此字段可能返回 null,表示取不到有效值。
示例值:www.aaa.com
LoadBalancerVips Array of String 负载均衡实例的 VIP 列表。
注意:此字段可能返回 null,表示取不到有效值。
示例值:[43.123.xx.xxx]
Status Integer 负载均衡实例的状态,包括
0:创建中,1:正常运行。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
CreateTime String 负载均衡实例的创建时间。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2020-12-08 08:00:00
StatusTime String 负载均衡实例的上次状态转换时间。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2020-12-08 08:00:00
ProjectId Integer 负载均衡实例所属的项目 ID, 0 表示默认项目。
示例值:0
VpcId String 私有网络的 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:vpc-mj65xxxx
OpenBgp Integer 高防 LB 的标识,1:高防负载均衡 0:非高防负载均衡。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
Snat Boolean 在 2016 年 12 月份之前的传统型内网负载均衡都是开启了 snat 的。
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
Isolation Integer 0:表示未被隔离,1:表示被隔离。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
SubnetId String 负载均衡实例所在的子网(仅对内网VPC型LB有意义)
注意:此字段可能返回 null,表示取不到有效值。
示例值:subnet-lzj3xxxx
Tags Array of TagInfo 负载均衡实例的标签信息
注意:此字段可能返回 null,表示取不到有效值。
SecureGroups Array of String 负载均衡实例的安全组
注意:此字段可能返回 null,表示取不到有效值。
示例值:sg-hx6dxxxx
TargetRegionInfo TargetRegionInfo 负载均衡实例绑定的后端设备的基本信息
注意:此字段可能返回 null,表示取不到有效值。
AnycastZone String anycast负载均衡的发布域,对于非anycast的负载均衡,此字段返回为空字符串
注意:此字段可能返回 null,表示取不到有效值。
示例值: null
AddressIPVersion String IP版本,ipv4 | ipv6
注意:此字段可能返回 null,表示取不到有效值。
示例值:ipv4
NumericalVpcId Integer 数值形式的私有网络 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:77599
VipIsp String 负载均衡IP地址所属的运营商。取值范围(BGP、CMCC、CTCC、CUCC)
注意:此字段可能返回 null,表示取不到有效值。
示例值:BGP
MasterZone ZoneInfo 主可用区
注意:此字段可能返回 null,表示取不到有效值。
BackupZoneSet Array of ZoneInfo 备可用区
注意:此字段可能返回 null,表示取不到有效值。
IsolatedTime String 负载均衡实例被隔离的时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-02-12 12:15:08
ExpireTime String 负载均衡实例的过期时间,仅对预付费负载均衡生效
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-02-12 12:15:08
ChargeType String 负载均衡实例的计费类型,PREPAID:包年包月,POSTPAID_BY_HOUR:按量计费
注意:此字段可能返回 null,表示取不到有效值。
示例值:POSTPAID_BY_HOUR
NetworkAttributes InternetAccessible 负载均衡实例的网络属性
注意:此字段可能返回 null,表示取不到有效值。
PrepaidAttributes LBChargePrepaid 负载均衡实例的预付费相关属性
注意:此字段可能返回 null,表示取不到有效值。
LogSetId String 负载均衡日志服务(CLS)的日志集ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:c32fc818-e984-414a-b8f5-3985b4c5xxxx
LogTopicId String 负载均衡日志服务(CLS)的日志主题ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:c32fc818-e984-414a-b8f5-3985b4c5xxxx
AddressIPv6 String 负载均衡实例的IPv6地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:2402:4e00:1000:4e00:0:920b:5519:d96d
ExtraInfo ExtraInfo 暂做保留,一般用户无需关注。
注意:此字段可能返回 null,表示取不到有效值。
IsDDos Boolean 是否可绑定高防包
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
ConfigId String 负载均衡维度的个性化配置ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:pz-5itmxxxxx
LoadBalancerPassToTarget Boolean 后端服务是否放通来自LB的流量
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
ExclusiveCluster ExclusiveCluster 内网独占集群
注意:此字段可能返回 null,表示取不到有效值。
IPv6Mode String IP地址版本为ipv6时此字段有意义, IPv6Nat64 | IPv6FullChain
注意:此字段可能返回 null,表示取不到有效值。
示例值:IPv6FullChain
SnatPro Boolean 是否开启SnatPro。
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
SnatIps Array of SnatIp 开启SnatPro负载均衡后,SnatIp列表。
注意:此字段可能返回 null,表示取不到有效值。
SlaType String 性能容量型规格
注意:此字段可能返回 null,表示取不到有效值。
示例值: null
IsBlock Boolean vip是否被封堵
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
IsBlockTime String 封堵或解封时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2021-02-12 12:15:08
LocalBgp Boolean IP类型是否是本地BGP
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
ClusterTag String 7层独占标签。
注意:此字段可能返回 null,表示取不到有效值。
示例值:FOR_TEST
MixIpTarget Boolean 开启IPv6FullChain负载均衡7层监听器支持混绑IPv4/IPv6目标功能。
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
Zones Array of String 私有网络内网负载均衡,就近接入模式下规则所落在的可用区
注意:此字段可能返回 null,表示取不到有效值。
示例值:null
NfvInfo String CLB是否为NFV,空:不是,l7nfv:七层是NFV。
注意:此字段可能返回 null,表示取不到有效值。
示例值:null
HealthLogSetId String 负载均衡日志服务(CLS)的健康检查日志集ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:c32fc818-e984-414a-b8f5-3985b4c51111
HealthLogTopicId String 负载均衡日志服务(CLS)的健康检查日志主题ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:c32fc818-e984-414a-b8f5-3985b4c52222
ClusterIds Array of String 集群ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:cluster-1234xxxx
AttributeFlags Array of String 负载均衡的属性
注意:此字段可能返回 null,表示取不到有效值。
示例值:DeleteProtect
LoadBalancerDomain String 负载均衡实例的域名。
注意:此字段可能返回 null,表示取不到有效值。
示例值:lb-xxxxxxx-e4841923c1214a90.clb.ap-guangzhou.tencentclb.com
Egress String 网络出口
注意:此字段可能返回 null,表示取不到有效值。
示例值:center_egress1

LoadBalancerDetail

负载均衡详细信息

被如下接口引用:DescribeLoadBalancersDetail。

名称 类型 描述
LoadBalancerId String 负载均衡实例 ID。
示例值:lb-12345678
LoadBalancerName String 负载均衡实例的名称。
示例值:test
LoadBalancerType String 负载均衡实例的网络类型:
Public:公网属性, Private:内网属性。
注意:此字段可能返回 null,表示取不到有效值。
示例值:OPEN
Status Integer 负载均衡实例的状态,包括
0:创建中,1:正常运行。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Address String 负载均衡实例的 VIP 。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1.1.1.1
AddressIPv6 String 负载均衡实例 VIP 的IPv6地址。
注意:此字段可能返回 null,表示取不到有效值。
示例值:null
AddressIPVersion String 负载均衡实例IP版本,IPv4 | IPv6。
注意:此字段可能返回 null,表示取不到有效值。
示例值:IPv4
IPv6Mode String 负载均衡实例IPv6地址类型,IPv6Nat64 | IPv6FullChain。
注意:此字段可能返回 null,表示取不到有效值。
示例值:null
Zone String 负载均衡实例所在可用区。
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-guangzhou-1
AddressIsp String 负载均衡实例IP地址所属的ISP。取值范围:BGP(多线)、CMCC(中国移动)、CUCC(中国联通)、CTCC(中国电信)、INTERNAL(内网)。
注意:此字段可能返回 null,表示取不到有效值。
示例值:CMCC
VpcId String 负载均衡实例所属私有网络的 ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:vpc-12345678
ProjectId Integer 负载均衡实例所属的项目 ID, 0 表示默认项目。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
CreateTime String 负载均衡实例的创建时间。
注意:此字段可能返回 null,表示取不到有效值。
示例值:2020-01-01 00:00:00
ChargeType String 负载均衡实例的计费类型。取值范围:PREPAID预付费、POSTPAID_BY_HOUR按量付费。
注意:此字段可能返回 null,表示取不到有效值。
示例值:POSTPAID_BY_HOUR
NetworkAttributes InternetAccessible 负载均衡实例的网络属性。
注意:此字段可能返回 null,表示取不到有效值。
示例值:null
PrepaidAttributes LBChargePrepaid 负载均衡实例的预付费相关属性。
注意:此字段可能返回 null,表示取不到有效值。
示例值:null
ExtraInfo ExtraInfo 暂做保留,一般用户无需关注。
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"ZhitTong":false,"TgwGroupName":null}
ConfigId String 负载均衡维度的个性化配置ID,多个配置用逗号隔开。
注意:此字段可能返回 null,表示取不到有效值。
示例值:pz-12345678
Tags Array of TagInfo 负载均衡实例的标签信息。
注意:此字段可能返回 null,表示取不到有效值。
示例值:[{"TagKey":"1","TagValue":"2"}]
ListenerId String 负载均衡监听器 ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:lbl-12345678
Protocol String 监听器协议。
注意:此字段可能返回 null,表示取不到有效值。
示例值:tcp
Port Integer 监听器端口。
注意:此字段可能返回 null,表示取不到有效值。
示例值:80
LocationId String 转发规则的 ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:loc-12345678
Domain String 转发规则的域名。
注意:此字段可能返回 null,表示取不到有效值。
示例值:test.com
Url String 转发规则的路径。
注意:此字段可能返回 null,表示取不到有效值。
示例值:/
TargetId String 后端目标ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:ins-12345678
TargetAddress String 后端目标的IP地址。
注意:此字段可能返回 null,表示取不到有效值。
示例值:172.16.0.2
TargetPort Integer 后端目标监听端口。
注意:此字段可能返回 null,表示取不到有效值。
示例值:80
TargetWeight Integer 后端目标转发权重。
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
Isolation Integer 0:表示未被隔离,1:表示被隔离。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
SecurityGroup Array of String 负载均衡绑定的安全组列表。
注意:此字段可能返回 null,表示取不到有效值。
示例值:["sg-12345678"]
LoadBalancerPassToTarget Integer 负载均衡安全组上移特性是否开启标识。取值范围:1表示开启、0表示未开启。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TargetHealth String 后端目标健康状态。
注意:此字段可能返回 null,表示取不到有效值。
示例值:Alive
Domains String 转发规则的域名列表。
注意:此字段可能返回 null,表示取不到有效值。
示例值:["www.xxxx.com"]
SlaveZone Array of String 多可用区负载均衡实例所选备区
注意:此字段可能返回 null,表示取不到有效值。
示例值:["ap-guangzhou-2"]
Zones Array of String 内网负载均衡实例所在可用区,由白名单CLB_Internal_Zone控制
注意:此字段可能返回 null,表示取不到有效值。
示例值:["ap-guangzhou-1"]
SniSwitch Integer 是否开启SNI特性,1:表示开启,0:表示不开启(本参数仅对于HTTPS监听器有意义)。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
LoadBalancerDomain String 负载均衡实例的域名。
注意:此字段可能返回 null,表示取不到有效值。
示例值:lb-xxxxxxx-e4841923c1214a90.clb.ap-guangzhou.tencentclb.com
Egress String 网络出口
注意:此字段可能返回 null,表示取不到有效值。
示例值:center_egress1

LoadBalancerHealth

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

被如下接口引用:DescribeTargetHealth。

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

LoadBalancerTraffic

负载均衡流量数据。

被如下接口引用:DescribeLoadBalancerTraffic。

名称 类型 描述
LoadBalancerId String 负载均衡ID
示例值:lb-xxxxxxx
LoadBalancerName String 负载均衡名字
示例值:test-name
Region String 负载均衡所在地域
示例值:ap-guangzhou
Vip String 负载均衡的vip
示例值:1.1.1.1
OutBandwidth Float 最大出带宽,单位:Mbps
示例值:17
Domain String CLB域名
注意:此字段可能返回 null,表示取不到有效值。
示例值:ap-guang.safsadf.tencentclb.com

MultiCertInfo

CLB监听器或规则绑定的多证书信息

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

名称 类型 必选 描述
SSLMode String 认证类型,UNIDIRECTIONAL:单向认证,MUTUAL:双向认证
示例值:UNIDIRECTIONAL
CertList Array of CertInfo 监听器或规则证书列表,单双向认证,多本服务端证书算法类型不能重复;若SSLMode为双向认证,证书列表必须包含一本ca证书。
示例值:见起类型示例

Price

表示负载均衡的价格

被如下接口引用:InquiryPriceCreateLoadBalancer, InquiryPriceModifyLoadBalancer, InquiryPriceRefundLoadBalancer, InquiryPriceRenewLoadBalancer。

名称 类型 描述
InstancePrice ItemPrice 描述了实例价格。
注意:此字段可能返回 null,表示取不到有效值。
BandwidthPrice ItemPrice 描述了网络价格。
注意:此字段可能返回 null,表示取不到有效值。
LcuPrice ItemPrice 描述了lcu价格。
注意:此字段可能返回 null,表示取不到有效值。

Quota

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

被如下接口引用:DescribeQuota。

名称 类型 描述
QuotaId String 配额名称,取值范围:
  • TOTAL_OPEN_CLB_QUOTA:用户当前地域下的公网CLB配额
  • TOTAL_INTERNAL_CLB_QUOTA:用户当前地域下的内网CLB配额
  • TOTAL_LISTENER_QUOTA:一个CLB下的监听器配额
  • TOTAL_LISTENER_RULE_QUOTA:一个监听器下的转发规则配额
  • TOTAL_TARGET_BIND_QUOTA:一条转发规则下可绑定设备的配额
  • TOTAL_SNAP_IP_QUOTA: 一个CLB实例下跨地域2.0的SNAT IP配额
  • TOTAL_ISP_CLB_QUOTA:用户当前地域下的三网CLB配额

  • 示例值:TOTAL_OPEN_CLB_QUOTA
    QuotaCurrent Integer 当前使用数量,为 null 时表示无意义。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:null
    QuotaLimit Integer 配额数量。
    示例值:3

    Resource

    资源详细信息

    被如下接口引用:DescribeResources。

    名称 类型 描述
    Type Array of String 运营商内具体资源信息,如"CMCC", "CUCC", "CTCC", "BGP", "INTERNAL"。
    示例值:CMCC
    Isp String 运营商信息,如"CMCC", "CUCC", "CTCC", "BGP", "INTERNAL"。
    示例值:CMCC
    AvailabilitySet Array of ResourceAvailability 可用资源。
    注意:此字段可能返回 null,表示取不到有效值。
    TypeSet Array of TypeInfo 运营商类型信息
    注意:此字段可能返回 null,表示取不到有效值。

    ResourceAvailability

    资源可用性

    被如下接口引用:DescribeResources。

    名称 类型 描述
    Type String 运营商内具体资源信息,如"CMCC", "CUCC", "CTCC", "BGP"。
    示例值:CMCC
    Availability String 资源可用性,"Available":可用,"Unavailable":不可用
    示例值:Available

    RewriteLocationMap

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

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

    名称 类型 必选 描述
    SourceLocationId String 源转发规则ID
    示例值:loc-i82k****
    TargetLocationId String 重定向目标转发规则的ID
    示例值:loc-lavx****
    RewriteCode Integer 重定向状态码,可取值301,302,307
    示例值:302
    TakeUrl Boolean 重定向是否携带匹配的url,配置RewriteCode时必填
    示例值:true
    SourceDomain String 源转发的域名,必须是SourceLocationId对应的域名,配置RewriteCode时必填
    示例值:xxx.com

    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,表示取不到有效值。

    RsTagRule

    修改节点标签的数据类型

    被如下接口引用:BatchModifyTargetTag。

    名称 类型 必选 描述
    ListenerId String 负载均衡监听器 ID。
    示例值:lis-cuxw****
    Targets Array of Target 要修改标签的后端机器列表。
    LocationId String 转发规则的ID,七层规则时需要此参数,4层规则不需要。
    示例值:loc-o8cn****
    Tag String 后端服务修改后的标签。此参数的优先级低于前述Target中的Tag参数,即最终的标签以Target中的Tag参数值为准,仅当Target中的Weight参数为空时,才以RsTagRule中的Tag参数为准。
    示例值:xxxx

    RsWeightRule

    修改节点权重的数据类型

    被如下接口引用:BatchModifyTargetWeight。

    名称 类型 必选 描述
    ListenerId String 负载均衡监听器 ID。
    示例值:lb-cuxw****
    Targets Array of Target 要修改权重的后端机器列表。
    LocationId String 转发规则的ID,七层规则时需要此参数,4层规则不需要。
    示例值:loc-o8cn****
    Weight Integer 后端服务修改后的转发权重,取值范围:[0,100]。此参数的优先级低于前述Target中的Weight参数,即最终的权重值以Target中的Weight参数值为准,仅当Target中的Weight参数为空时,才以RsWeightRule中的Weight参数为准。
    示例值:10

    RuleHealth

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

    被如下接口引用:DescribeTargetHealth。

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

    RuleInput

    HTTP/HTTPS转发规则(输入)

    被如下接口引用:CreateRule。

    名称 类型 必选 描述
    Url String 转发规则的路径。长度限制为:1~200。
    示例值:/xxxx
    Domain String 转发规则的域名。长度限制为:1~80。Domain和Domains只需要传一个,单域名规则传Domain,多域名规则传Domains。
    示例值:www.xxxx.com
    SessionExpireTime Integer 会话保持时间。设置为0表示关闭会话保持,开启会话保持可取值30~86400,单位:秒。
    示例值:30
    HealthCheck HealthCheck 健康检查信息。详情请参见:健康检查
    示例值:{"HealthSwitch": 1, "TimeOut": 5, "IntervalTime": 5, "HealthNum"
    Certificate CertificateInput 证书信息;此参数和MultiCertInfo不能同时传入。
    示例值:{"SSLMode": "UNIDIRECTIONAL", "CertId": "fF6AGfxE"}
    Scheduler String 规则的请求转发方式,可选值:WRR、LEAST_CONN、IP_HASH
    分别表示按权重轮询、最小连接数、按IP哈希, 默认为 WRR。
    示例值:WRR
    ForwardType String 负载均衡与后端服务之间的转发协议,目前支持 HTTP/HTTPS/GRPC/TRPC,TRPC暂未对外开放,默认HTTP。
    示例值:HTTP
    DefaultServer Boolean 是否将该域名设为默认域名,注意,一个监听器下只能设置一个默认域名。
    示例值:true
    Http2 Boolean 是否开启Http2,注意,只有HTTPS域名才能开启Http2。
    示例值:true
    TargetType String 后端目标类型,NODE表示绑定普通节点,TARGETGROUP表示绑定目标组
    示例值:NODE
    TrpcCallee String TRPC被调服务器路由,ForwardType为TRPC时必填。目前暂未对外开放。
    示例值:trpcall
    TrpcFunc String TRPC调用服务接口,ForwardType为TRPC时必填。目前暂未对外开放
    示例值:trpcFunc
    Quic Boolean 是否开启QUIC,注意,只有HTTPS域名才能开启QUIC
    示例值:true
    Domains Array of String 转发规则的域名列表。每个域名的长度限制为:1~80。Domain和Domains只需要传一个,单域名规则传Domain,多域名规则传Domains。
    示例值:["www.xxxx.com"]
    MultiCertInfo MultiCertInfo 证书信息,支持同时传入不同算法类型的多本服务端证书;此参数和Certificate不能同时传入。

    RuleOutput

    HTTP/HTTPS监听器的转发规则(输出)

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

    名称 类型 描述
    LocationId String 转发规则的 ID
    示例值:loc-xxx
    Domain String 转发规则的域名。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:www.xxxx.com
    Url String 转发规则的路径。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:/test
    SessionExpireTime Integer 会话保持时间
    示例值:0
    HealthCheck HealthCheck 健康检查信息
    注意:此字段可能返回 null,表示取不到有效值。
    Certificate CertificateOutput 证书信息
    注意:此字段可能返回 null,表示取不到有效值。
    Scheduler String 规则的请求转发方式。
    WRR、LEAST_CONN、IP_HASH分别表示按权重轮询、最小连接数、IP Hash。
    示例值:WRR
    ListenerId String 转发规则所属的监听器 ID
    示例值:lbl-8cnl****
    RewriteTarget RewriteTarget 转发规则的重定向目标信息
    注意:此字段可能返回 null,表示取不到有效值。
    HttpGzip Boolean 是否开启gzip
    示例值:true
    BeAutoCreated Boolean 转发规则是否为自动创建
    示例值:false
    DefaultServer Boolean 是否作为默认域名
    示例值:true
    Http2 Boolean 是否开启Http2
    示例值:false
    ForwardType String 负载均衡与后端服务之间的转发协议
    示例值:HTTP
    CreateTime String 转发规则的创建时间
    示例值:2024-01-22 14:36:12
    TargetType String 后端服务器类型。NODE表示绑定普通节点,TARGETGROUP表示绑定目标组。
    示例值:NODE
    TargetGroup BasicTargetGroupInfo 绑定的目标组基本信息;当规则绑定目标组时,会返回该字段
    注意:此字段可能返回 null,表示取不到有效值。
    WafDomainId String WAF实例ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    TrpcCallee String TRPC被调服务器路由,ForwardType为TRPC时有效。目前暂未对外开放。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    TrpcFunc String TRPC调用服务接口,ForwardType为TRPC时有效。目前暂未对外开放。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    QuicStatus String QUIC状态。QUIC_ACTIVE表示开启,QUIC_INACTIVE表示未开启。注意,只有HTTPS域名才能开启QUIC。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:QUIC_INACTIVE
    Domains Array of String 转发规则的域名列表。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["www.xxxx.com"]
    TargetGroupList Array of BasicTargetGroupInfo 绑定的目标组列表
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:null

    RuleTargets

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

    被如下接口引用:DescribeTargets。

    名称 类型 描述
    LocationId String 转发规则的 ID
    示例值:loc-i82k****
    Domain String 转发规则的域名
    示例值:xxx.com
    Url String 转发规则的路径。
    示例值:/xxx
    Targets Array of Backend 后端服务的信息
    注意:此字段可能返回 null,表示取不到有效值。
    FunctionTargets Array of FunctionTarget 后端云函数的信息
    注意:此字段可能返回 null,表示取不到有效值。

    RulesItems

    七层规则对象

    被如下接口引用:DescribeLBListeners。

    名称 类型 描述
    LocationId String 规则id
    Domain String 域名
    Url String uri
    Targets Array of LbRsTargets 绑定的后端对象

    SlaUpdateParam

    升级为性能容量型参数

    被如下接口引用:ModifyLoadBalancerSla。

    名称 类型 必选 描述
    LoadBalancerId String lb的字符串ID
    示例值:lb-12345678
    SlaType String 性能容量型规格,取值范围:
  • clb.c2.medium:标准型规格
  • clb.c3.small:高阶型1规格
  • clb.c3.medium:高阶型2规格
  • clb.c4.small:超强型1规格
  • clb.c4.medium:超强型2规格
  • clb.c4.large:超强型3规格
  • clb.c4.xlarge:超强型4规格
  • 如需了解规格详情,请参见实例规格对比
    示例值:SLA

    SnatIp

    SnatIp的信息结构

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

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

    SpecAvailability

    规格可用性

    被如下接口引用:DescribeResources。

    名称 类型 描述
    SpecType String 规格类型。
  • clb.c2.medium(标准型)
  • clb.c3.small(高阶型1)
  • clb.c3.medium(高阶型2)
  • clb.c4.small(超强型1)
  • clb.c4.medium(超强型2)
  • clb.c4.large(超强型3)
  • clb.c4.xlarge(超强型4)
  • shared(共享型)


  • 注意:此字段可能返回 null,表示取不到有效值。
    示例值:shared
    Availability String 规格可用性。资源可用性,"Available":可用,"Unavailable":不可用
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:Available

    TagInfo

    负载均衡的标签信息

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

    名称 类型 必选 描述
    TagKey String 标签的键
    示例值:key-xxx
    TagValue String 标签的值
    示例值:value-xxx

    Target

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

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

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

    TargetGroupAssociation

    规则与目标组的关联关系

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

    名称 类型 必选 描述
    LoadBalancerId String 负载均衡ID
    示例值:lb-agcadfe
    TargetGroupId String 目标组ID
    示例值:lbtg-0nzo3czo
    ListenerId String 监听器ID。访问AssociateTargetGroups和DisassociateTargetGroups接口时必传此参数。
    示例值:lbl-xxxx
    LocationId String 转发规则ID
    示例值:loc-aaaaaa

    TargetGroupBackend

    目标组绑定的后端服务器

    被如下接口引用:DescribeTargetGroupInstances。

    名称 类型 描述
    TargetGroupId String 目标组ID
    示例值:lbtg-5f37****
    Type String 后端服务的类型,可取:CVM、ENI(即将支持)
    示例值:CVM
    InstanceId String 后端服务的唯一 ID
    示例值:ins-2bei****
    Port Integer 后端服务的监听端口
    示例值:80
    Weight Integer 后端服务的转发权重,取值范围:[0, 100],默认为 10。
    示例值:10
    PublicIpAddresses Array of String 后端服务的外网 IP
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[1.1.1.1]
    PrivateIpAddresses Array of String 后端服务的内网 IP
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[2.2.2.2]
    InstanceName String 后端服务的实例名称
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:testName
    RegisteredTime Timestamp 后端服务被绑定的时间
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2021-03-16 00:00:00
    EniId String 弹性网卡唯一ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:eni-jf7u****
    ZoneId Integer 后端服务的可用区ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:400001

    TargetGroupInfo

    目标组信息

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

    名称 类型 描述
    TargetGroupId String 目标组ID
    示例值:lbtg-xxxxxxxx
    VpcId String 目标组的vpcid
    示例值:vpc-xxxxxxxx
    TargetGroupName String 目标组的名字
    示例值:Name
    Port Integer 目标组的默认端口
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:60
    CreatedTime Timestamp 目标组的创建时间
    示例值:2022-03-23 10:37:16
    UpdatedTime Timestamp 目标组的修改时间
    示例值:2022-03-23 10:37:16
    AssociatedRule Array of AssociationItem 关联到的规则数组。在DescribeTargetGroupList接口调用时无法获取到该参数。
    注意:此字段可能返回 null,表示取不到有效值。

    TargetGroupInstance

    目标组实例

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

    名称 类型 必选 描述
    BindIP String 目标组实例的内网IP
    示例值:x.x.x.x
    Port Integer 目标组实例的端口
    示例值:80
    Weight Integer 目标组实例的权重
    示例值:10
    NewPort Integer 目标组实例的新端口
    示例值:80

    TargetHealth

    描述一个Target的健康信息

    被如下接口引用:DescribeTargetHealth。

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

    TargetRegionInfo

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

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

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

    TypeInfo

    运营商类型信息

    被如下接口引用:DescribeResources。

    名称 类型 描述
    Type String 运营商类型
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:BGP
    SpecAvailabilitySet Array of SpecAvailability 规格可用性
    注意:此字段可能返回 null,表示取不到有效值。

    ZoneInfo

    可用区相关信息

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

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

    ZoneResource

    可用区资源列表

    被如下接口引用:DescribeResources。

    名称 类型 描述
    MasterZone String 主可用区,如"ap-guangzhou-1"。
    示例值:ap-guangzhou-2
    ResourceSet Array of Resource 资源列表。
    注意:此字段可能返回 null,表示取不到有效值。
    SlaveZone String 备可用区,如"ap-guangzhou-2",单可用区时,备可用区为null。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ap-guangzhou-3
    IPVersion String IP版本,如IPv4,IPv6,IPv6_Nat。
    示例值:IPv4
    ZoneRegion String 可用区所属地域,如:ap-guangzhou
    示例值:ap-guangzhou
    LocalZone Boolean 可用区是否是LocalZone可用区,如:false
    示例值:false
    ZoneResourceType String 可用区资源的类型,SHARED表示共享资源,EXCLUSIVE表示独占资源。
    示例值:"SHARED"
    EdgeZone Boolean 可用区是否是EdgeZone可用区,如:false
    示例值:false
    Egress String 网络出口
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:center_egress1