租户端网络负载均衡（CLB）数据结构

数据结构

最近更新时间: 2024-12-21 13:01:31

CfgProductCode

询价接口入参，购买LB实例的标签描述

被如下接口引用：

名称	必选	允许NULL	类型	描述
ProductCode	是	否	String	购买的产品的标签示例值： p_clb
SubProductCode	是	否	String	购买的子产品的标签示例值： sp_clb_forward

OwnerLabel

用户和标签对应关系

被如下接口引用：DescribeAppIdLabel

名称	必选	允许NULL	类型	描述
Owner	是	否	Uint64	用户AppId 示例值： 127000001
Label	是	否	String	集群标签示例值： testlabel
SetType	是	否	String	集群标签类型，取值为L4_LAN_CLB，L4_WAN_CLB，L4_CLB，L7_LAN_CLB，L7_WAN_CLB，L7_CLB 示例值： L4_LAN_CLB

RuleTargets

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

被如下接口引用：DescribeTargets

名称	必选	允许NULL	类型	描述
LocationId	是	否	String	转发规则的 ID 示例值： loc-i82k****
Domain	是	否	String	转发规则的域名示例值： xxx.com
Url	是	否	String	转发规则的路径。示例值： /xxx
Targets	是	是	Array of Backend	后端服务的信息示例值：查看
FunctionTargets	否	是	Array of FunctionTarget	后端云函数的信息（TCE暂不支持）示例值：查看

TargetGroupAssociation

规则与目标组的关联关系

被如下接口引用：

名称	必选	允许NULL	类型	描述
LoadBalancerId	是	否	String	负载均衡ID 示例值： lb-agcadfe
ListenerId	是	否	String	监听器ID 示例值： lbl-xxxx
LocationId	否	否	String	转发规则ID 示例值： loc-aaaaaa
TargetGroupId	是	否	String	目标组ID 示例值： lbtg-0nzo3czo

Filter

过滤器条件

被如下接口引用：DescribeClusterResources、DescribeListeners、DescribeLoadBalancers、DescribeTargetGroupList、DescribeTargetGroups

名称	必选	允许NULL	类型	描述
Name	是	否	String	过滤器的名称示例值： loadbalancerIds
Values	是	否	Array of String	过滤器的值数组示例值： ["lb-xxxxxxxx"]

BasicTargetGroupInfo

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

被如下接口引用：DescribeListeners、DescribeRewrite

名称	必选	允许NULL	类型	描述
TargetGroupId	是	否	String	目标组ID 示例值： tg-xxxxxxxx
TargetGroupName	是	否	String	目标组名称示例值： test-tg

ConfigListItem

配置内容

被如下接口引用：DescribeCustomizedConfigList

名称	必选	允许NULL	类型	描述
UconfigId	是	否	String	配置ID 示例值： pz-xxxxxxxx
ConfigType	是	否	String	配置类型示例值： CLB
ConfigName	是	是	String	配置名字示例值： test
ConfigContent	是	否	String	配置内容示例值： add_header aaa bbb;\r\n
CreateTimestamp	是	否	String	增加配置时间示例值： 1702903612
UpdateTimestamp	是	否	String	修改配置时间示例值： 1702903612

RegionItem

地域信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
Region	是	否	String	地域，如"ap-guangzhou"。示例值： ap-guangzhou
RegionId	是	否	Uint64	地域ID，如1。示例值： 500000001
RegionPrefix	是	否	String	地域缩写，如"gz"。示例值： ap

Test

test

被如下接口引用：

名称	必选	允许NULL	类型	描述
A	是	是	String	A 示例值： a

BindItem

配置绑定关系

被如下接口引用：AssociateCustomizedConfig

名称	必选	允许NULL	类型	描述
LoadBalancerId	是	否	String	配置绑定的CLB ID 示例值： lb-4d2y****
ListenerId	是	是	String	配置绑定的监听器ID 示例值： lbl-ds2y****
Domain	是	是	String	配置绑定的域名示例值： foo.net
LocationId	否	是	String	配置绑定的规则示例值： loc-jdhs****

CertificateInput

证书信息

被如下接口引用：CreateListener、CreateRule、ModifyDomainAttributes、ModifyListener

名称	必选	允许NULL	类型	描述
SSLMode	否	否	String	认证类型，UNIDIRECTIONAL：单向认证，MUTUAL：双向认证示例值： MUTUAL
CertId	否	否	String	服务端RSA证书的 ID，如果不填写此项则必须上传证书，包括 CertContent，CertKey，CertName。示例值： j9sl3xs2
CertCaId	否	否	String	客户端CA证书的 ID，当监听器采用双向认证，即 SSLMode=MUTUAL 时，如果不填写此项则必须上传客户端证书，包括 CertCaContent，CertCaName。示例值： j9sl3xs2
CertName	否	否	String	上传服务端RSA证书的名称，如果没有 CertId，则此项必传。示例值： test
CertKey	否	否	String	上传服务端RSA证书的 key，如果没有 CertId，则此项必传。示例值： -----BEGIN RSA PRIVATE KEY-----\r\n******\r\n-----END RSA PRIVATE KEY-----\r\n
CertContent	否	否	String	上传服务端RSA证书的内容，如果没有 CertId，则此项必传。示例值： -----BEGIN CERTIFICATE-----\r\n****\r\n-----END CERTIFICATE-----\r\n
CertCaName	否	否	String	上传客户端 CA 证书的名称，如果 SSLMode=mutual，如果没有 CertCaId，则此项必传。示例值： test
CertCaContent	否	否	String	上传客户端证书的内容，如果 SSLMode=mutual，如果没有 CertCaId，则此项必传。示例值： -----BEGIN CERTIFICATE-----\r\n****\r\n-----END CERTIFICATE-----\r\n
EccCertId	否	否	String	服务端ECC证书的 ID，如果不填写此项则必须上传证书，包括 CertContent，CertKey，CertName。示例值： xfdj3ghx
EccCertName	否	否	String	上传服务端ECC证书的名称，如果没有 CertEccId，则此项必传。示例值： test
EccCertContent	否	否	String	上传服务端ECC证书的内容，如果没有 CertEccId，则此项必传。示例值： -----BEGIN CERTIFICATE-----\r\n****\r\n-----END CERTIFICATE-----\r\n
EccCertKey	否	否	String	上传服务端ECC证书的key，如果没有 CertEccId，则此项必传。示例值： -----BEGIN RSA PRIVATE KEY-----\r\n******\r\n-----END RSA PRIVATE KEY-----\r\n
SmCertId	否	否	String	服务端国密SM证书的 ID，如果不填写此项则必须上传证书，包括 CertSMContent，CertSmKey，CertSMName，CertSMSignContent，CertSMSignKey。示例值： xfdj3ghx
SmCertName	否	否	String	上传服务端国密SM证书的名称，如果没有 CertSMId，则此项必传。示例值： test
SmCertSignContent	否	否	String	上传服务端国密SM证书的签名公约，如果没有 CertSMId，则此项必传。示例值： -----BEGIN CERTIFICATE-----\r\n****\r\n-----END CERTIFICATE-----\r\n
SmCertSignKey	否	否	String	上传服务端国密SM证书的签名密钥，如果没有 CertSMId，则此项必传。示例值： -----BEGIN RSA PRIVATE KEY-----\r\n******\r\n-----END RSA PRIVATE KEY-----\r\n
SmCertContent	否	否	String	上传服务端国密SM证书的证书公约，如果没有 CertSMId，则此项必传。示例值： -----BEGIN CERTIFICATE-----\r\n****\r\n-----END CERTIFICATE-----\r\n
SmCertKey	否	否	String	上传服务端国密SM证书的证书密钥，如果没有 CertSMId，则此项必传。示例值： -----BEGIN RSA PRIVATE KEY-----\r\n******\r\n-----END RSA PRIVATE KEY-----\r\n

LBChargePrepaid

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

被如下接口引用：DescribeLoadBalancerListByCertId、DescribeLoadBalancers、DescribeLoadBalancersForVpc、InquiryPriceCreateLoadBalancer、ModifyLoadBalancerAttributes

名称	必选	允许NULL	类型	描述
RenewFlag	否	是	String	续费类型：AUTO_RENEW 自动续费， MANUAL_RENEW 手动续费示例值： test
Period	否	是	Int64	购买时长，单位：月示例值： 100

TagInfo

负载均衡的标签信息

被如下接口引用：CreateLoadBalancer、DescribeLoadBalancerListByCertId、DescribeLoadBalancers、DescribeLoadBalancersForVpc

名称	必选	允许NULL	类型	描述
TagKey	是	否	String	标签的键示例值： key-xxx
TagValue	是	否	String	标签的值示例值： value-xxx

Test2

建错了

被如下接口引用：

名称	必选	允许NULL	类型	描述
X	是	是	Int64	xxx 示例值： x

ZoneSlaItem

可用区可以购买的新能保障规格集合

被如下接口引用：

名称	必选	允许NULL	类型	描述
ZoneId	是	是	String	可用区id 示例值： 50001001
SlaSet	是	是	Array of String	可以购买的性能保障规格示例值： set1

AssociationItem

目标组关联到的规则

被如下接口引用：DescribeTargetGroupList、DescribeTargetGroups

名称	必选	允许NULL	类型	描述
LoadBalancerId	是	否	String	关联到的负载均衡ID 示例值： lb-xxxxxxxxx
ListenerId	是	否	String	关联到的监听器ID 示例值： lbl-xxxxxxxx
LocationId	是	是	String	关联到的转发规则ID 示例值： loc-xxxxxxxx
Protocol	是	否	String	关联到的监听器协议类型，如HTTP,TCP, 示例值： HTTP
Port	是	否	Uint64	关联到的监听器端口示例值： 80
Domain	是	是	String	关联到的转发规则域名示例值： foo.net
Url	是	是	String	关联到的转发规则URL 示例值： /
LoadBalancerName	是	否	String	负载均衡名称示例值： test-lb
ListenerName	是	否	String	监听器名称示例值： test-lbl

LoadBalancerHealth

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

被如下接口引用：DescribeTargetHealth

名称	必选	允许NULL	类型	描述
LoadBalancerId	是	否	String	负载均衡实例ID 示例值： lb-xxxxxxxx
LoadBalancerName	是	是	String	负载均衡实例名称示例值： test
Listeners	是	是	Array of ListenerHealth	监听器列表示例值：查看

LocationRule

七层规则及后端服务器信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
Rule	是	否	RuleInput	新建转发规则的信息示例值：查看
Targets	否	否	Array of Target	待绑定的后端服务列表，数组长度最大支持20 示例值：查看
TargetGroupId	否	否	String	目标组ID 示例值： gp-xsdsfsd

VipAndVport

字典类型

被如下接口引用：

名称	必选	允许NULL	类型	描述
Vip	是	否	String	vip 示例值： 1.1.1.1
Vport	否	否	Uint64	端口号示例值： 80

ClassicalTarget

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

被如下接口引用：

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

OneCapacity

返回独占集群容量信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
SetName	是	否	String	集群名字示例值： 2
MaxConn	是	是	Uint64	最大连接数示例值： 100000
MaxQps	是	是	Uint64	最大Qps 示例值： 100000
MaxInPkg	是	是	Uint64	最大入包量，单位pps 示例值： 100000
MaxOutPkg	是	是	Uint64	最大出包量，单位pps 示例值： 100000
MaxInFlow	是	是	Uint64	最大入带宽，单位Mbps 示例值： 100000
MaxOutFlow	是	是	Uint64	最大出带宽，单位Mbps 示例值： 100000
MaxNewConn	是	是	Uint64	最大新建连接速率，单位：cps 示例值： 100000
HttpMaxNewConn	是	是	Uint64	最大新建连接速率，单位：cps 示例值： 100000
HttpsMaxNewConn	是	是	Uint64	最大新建连接速率，单位：cps 示例值： 100000
HttpsQps	是	是	Uint64	最大新建连接速率，单位：cps 示例值： 100000

ListenerItem

反查监听器类型

被如下接口引用：DescribeLBListeners

名称	必选	允许NULL	类型	描述
ListenerId	是	否	String	监听器ID 示例值： lbl-xxxxxxxx
Protocol	是	否	String	监听器协议示例值： TCP
Port	是	否	Int64	监听器端口示例值： 80
Rules	是	是	Array of RulesItems	绑定规则示例值：查看
Targets	是	是	Array of LbRsTargets	四层绑定对象示例值：查看
EndPort	是	是	Int64	端口段监听器的结束端口示例值： 80

ClassicalHealth

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

被如下接口引用：DescribeClassicalLBHealthStatus

名称	必选	允许NULL	类型	描述
IP	是	否	String	后端服务的内网 IP 示例值： 1.1.1.1
Port	是	否	Int64	后端服务的端口示例值： 80
ListenerPort	是	否	Int64	负载均衡的监听端口示例值： 80
Protocol	是	否	String	转发协议示例值： TCP
HealthStatus	是	否	Int64	健康检查结果，1 表示健康，0 表示不健康示例值： 0

ZoneResource

可用区资源列表

被如下接口引用：

名称	必选	允许NULL	类型	描述
MasterZone	是	否	String	主可用区，如"ap-guangzhou-1"。示例值： ap-guangzhou-2
ResourceSet	是	是	Array of Resource	资源列表。示例值：查看
SlaveZone	是	是	String	备可用区，如"ap-guangzhou-2"，单可用区时，备可用区为null。示例值： ap-guangzhou-3
IPVersion	是	否	String	IP版本，如IPv4，IPv6，IPv6_Nat。示例值： IPv4

LoadBalancerListenerRule

负载均衡监听器规则

被如下接口引用：

名称	必选	允许NULL	类型	描述
LoadBalancerId	是	否	String	负载均衡ID 示例值： lb-xxxxxxx
ListenerAttributes	是	否	Array of ListenerAttribute	四层七层监听器信息示例值：查看

RuleInput

HTTP/HTTPS转发规则（输入）

被如下接口引用：CreateRule

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

SetNameVIP

集群名 vip

被如下接口引用：

名称	必选	允许NULL	类型	描述
SetName	是	否	String	集群名示例值： l4-set
Vip	是	否	String	vip 示例值： 1.1.1.1
Vport	是	是	Uint64	端口号示例值： 80

ClassicalLoadBalancerInfo

负载均衡信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
InstanceId	是	否	String	后端实例ID 示例值： lb-xxxxxxxx
LoadBalancerIds	是	是	Array of String	负载均衡实例ID列表示例值： ["lb-xxxxxxxx"]

ClusterItem

独占集群信息

被如下接口引用：CreateLoadBalancer、DescribeLoadBalancerListByCertId、DescribeLoadBalancers、DescribeLoadBalancersForVpc、ModifyLoadBalancerAttributes

名称	必选	允许NULL	类型	描述
ClusterId	是	否	String	集群唯一ID 示例值： cluste-xxxxxxx
ClusterName	否	是	String	集群名称示例值： test
Zone	否	是	String	集群所在可用区，如ap-guangzhou-1 示例值： ap-guangzhou

CertList

租户端证书列表

被如下接口引用：DescribeCerts

名称	必选	允许NULL	类型	描述
OwnerUin	是	否	String	所有者示例值： 110000004918
ProjectId	是	否	String	项目ID 示例值： 0
From	是	否	String	证书来源示例值： upload
CertType	是	否	String	产品中文类型示例值： SVR
ProductZhName	是	否	String	中文名称示例值： zhangsan@test.com
Domain	是	否	String	项目域名示例值： zhangsan@test.com
Alias	是	否	String	证书备注或名称示例值： zhangsantest
Status	是	否	Int64	证书状态示例值： 1
VulnerAbilityStatus	是	否	String	漏洞状态示例值： INACTIVE
CertBeginTime	是	否	String	开始时间示例值： 2024-07-27 16:31:29
CertEndTime	是	否	String	过期时间示例值： 2025-07-27 16:31:29
ValidityPeriod	是	否	String	有效期示例值： 12
InsertTime	是	否	String	入库时间示例值： 2024-10-22 10:21:38
CertID	是	否	String	证书ID 示例值： Iz4eSk1n
StatusName	是	否	String	状态名称示例值：已通过
ProjectInfo	是	否	ProjectInfo	项目信息示例值：查看
Cert	是	否	String	证书内容示例值： -----BEGIN CERTIFICATE-----xxxxxx
SignCert	否	是	String	国密证书签名内容示例值： -----BEGIN CERTIFICATE-----xxxxxx
SubjectAltName	是	是	Array of String	备用域名列表示例值： test
CertAlgorithm	是	是	String	取值类型：rsa： ecc： sm2: 默认为 rsa 示例值： rsa

NetworkPriceInfo

网络计费信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
UnitPrice	是	否	Float	网络收费单位价格，示例值： 10.0
ChargeUnit	是	否	String	网络收费单位，GB按流量计费，HOUR按小时计算示例值： HOUR

TargetGroupInstance

目标组实例

被如下接口引用：

名称	必选	允许NULL	类型	描述
BindIP	是	否	String	目标组实例的内网IP 示例值： x.x.x.x
Port	是	否	Uint64	目标组实例的端口示例值： 80
Weight	否	否	Uint64	目标组实例的权重示例值： 10
NewPort	否	否	Uint64	目标组实例的新端口示例值： 80

ResourceAmount

描述资源量，包括调用次数、并发量、内存使用量、函数数量、网络流量等

被如下接口引用：

名称	必选	允许NULL	类型	描述
FunctionNum	是	否	Int64	asd 示例值： 3

BatchTarget

批量绑定类型

被如下接口引用：BatchDeregisterTargets、BatchRegisterTargets

名称	必选	允许NULL	类型	描述
ListenerId	是	否	String	监听器ID 示例值： lbl-2gas****
InstanceId	否	否	String	子机ID 示例值： ins-1vfj****
EniIp	否	否	String	弹性网卡ip 示例值： 10.0.X.X
Port	是	否	Int64	绑定端口示例值： 80
Weight	否	否	Int64	子机权重，范围[0, 100]。绑定时如果不存在，则默认为10。示例值： 10
LocationId	否	否	String	七层规则ID 示例值： lbl-4apy****

HealthCheck

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

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

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

TargetRegionInfo

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

被如下接口引用：DescribeLoadBalancerListByCertId、DescribeLoadBalancers、DescribeLoadBalancersForVpc、ModifyLoadBalancerAttributes

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

ExtraInfo

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

被如下接口引用：DescribeLoadBalancerListByCertId、DescribeLoadBalancers、DescribeLoadBalancersForVpc

名称	必选	允许NULL	类型	描述
ZhiTong	是	是	Bool	是否开通VIP直通示例值： 0
TgwGroupName	是	是	String	TgwGroup名称示例值： test

TargetGroupInfo

目标组信息

被如下接口引用：DescribeTargetGroupList、DescribeTargetGroups

名称	必选	允许NULL	类型	描述
TargetGroupId	是	否	String	目标组ID 示例值： lbtg-xxxxxxxx
VpcId	是	否	String	目标组的vpcid 示例值： vpc-xxxxxxxx
TargetGroupName	是	否	String	目标组的名字示例值： Name
Port	是	是	Uint64	目标组的默认端口示例值： 60
CreatedTime	是	否	Datetime	目标组的创建时间示例值： 2022-03-23 10:37:16
UpdatedTime	是	否	Datetime	目标组的修改时间示例值： 2022-03-23 10:37:16
AssociatedRule	是	是	Array of AssociationItem	关联到的规则数组示例值：查看

TestBAC

废弃

被如下接口引用：

名称	必选	允许NULL	类型	描述
Abc	是	否	Int64	阿打发斯蒂芬示例值： abc

ClusterResource

集群内资源类型

被如下接口引用：DescribeClusterResources

名称	必选	允许NULL	类型	描述
ClusterId	是	否	String	集群唯一ID，如tgw-12345678。示例值： tgw-12345678
Vip	是	否	String	ip地址。示例值： 1.1.1.2
LoadBalancerId	是	是	String	负载均衡唯一ID，如lb-12345678。示例值： lb-12345678
Idle	是	是	String	资源是否闲置。示例值： false
ClusterName	是	否	String	集群名称。示例值： cluster-1

IspSet

运营商信息描述

被如下接口引用：DescribeIspInfo

名称	必选	允许NULL	类型	描述
Id	是	否	Uint64	运营商ID 示例值： 2
Type	是	否	String	运营商类型示例值： CMCC
Name	是	否	String	运营商名称示例值：移动
IspStatus	是	否	Uint64	运营商IPv4状态示例值： 1
IspStatusIPv6	是	否	Uint64	运营商IPv6状态示例值： 1
V4alias	否	否	String	运营商v4别名示例值：移动
V6alias	否	否	String	运营商v6别名示例值：移动

ExclusiveCluster

独占集群

被如下接口引用：CreateLoadBalancer、DescribeLoadBalancerListByCertId、DescribeLoadBalancers、DescribeLoadBalancersForVpc、ModifyLoadBalancerAttributes

名称	必选	允许NULL	类型	描述
L4Clusters	否	是	Array of ClusterItem	4层独占集群列表示例值：查看
L7Clusters	否	是	Array of ClusterItem	7层独占集群列表示例值：查看
ClassicalCluster	否	是	ClusterItem	vpcgw集群示例值：查看

ClassicalTargetInfo

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

被如下接口引用：

名称	必选	允许NULL	类型	描述
InstanceId	是	否	String	后端实例ID 示例值： ins-xxxxxxxx
Weight	否	否	Int64	权重，取值范围 [0, 100] 示例值： 100

ItemPrice

描述了单项的价格信息

被如下接口引用：InquiryPriceCreateLoadBalancer、InquiryPriceModifyLoadBalancer

名称	必选	允许NULL	类型	描述
UnitPrice	是	是	Float	后付费单价，单位：元。示例值： 10
ChargeUnit	是	是	String	后续计价单元，可取值范围： HOUR：表示计价单元是按每小时来计算。当前涉及该计价单元的场景有：实例按小时后付费（POSTPAID_BY_HOUR）、带宽按小时后付费（BANDWIDTH_POSTPAID_BY_HOUR）； GB：表示计价单元是按每GB来计算。当前涉及该计价单元的场景有：流量按小时后付费（TRAFFIC_POSTPAID_BY_HOUR）。示例值： HOUR
OriginalPrice	是	是	Float	预支费用的原价，单位：元。示例值： 50
DiscountPrice	是	是	Float	预支费用的折扣价，单位：元。示例值： 50
UnitPriceDiscount	是	是	Float	后付费的折扣单价，单位:元示例值： 10
Discount	是	是	Float	折扣，如20.0代表2折。示例值： 100

LBItem

反查Lb绑定关系。

被如下接口引用：DescribeLBListeners

名称	必选	允许NULL	类型	描述
LoadBalancerId	是	否	String	lb的字符串id 示例值： lb-xxxxxxxx
Vip	是	否	String	lb的vip 示例值： 1.1.1.1
Listeners	是	否	Array of ListenerItem	监听器规则示例值：查看
Region	是	否	String	LB所在地域示例值： ap-guangzhou

LbRsTargets

反查结果数据类型。

被如下接口引用：DescribeLBListeners

名称	必选	允许NULL	类型	描述
Type	是	否	String	内网ip类型。“cvm”或“eni” 示例值： CVM
PrivateIp	是	否	String	后端实例的内网ip。示例值： 1.1.1.1
Port	是	否	Int64	绑定后端实例的端口。示例值： 80
VpcId	是	是	Int64	rs的vpcId 示例值： 67312
Weight	是	是	Int64	rs的权重示例值： 100

ZoneInfo

可用区相关信息

被如下接口引用：DescribeLoadBalancerListByCertId、DescribeLoadBalancers、DescribeLoadBalancersForVpc、DescribeMasterZones

名称	必选	允许NULL	类型	描述
ZoneId	是	是	Uint64	可用区数值形式的唯一ID，如：100001 示例值： 100001
Zone	是	是	String	可用区字符串形式的唯一ID，如：ap-guangzhou-1 示例值： ap-guangzhou-1
ZoneName	是	是	String	可用区名称，如：广州一区示例值：广州一区
ZoneRegion	否	是	String	可用区所在地域示例值： ap-guangzhou
LocalZone	否	是	Bool	可用区是否是LocalZone可用区示例值： false

Cluster

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

被如下接口引用：

名称	必选	允许NULL	类型	描述
ClusterId	是	否	String	集群唯一ID 示例值： stgw-clclwcxx
ClusterName	是	否	String	集群名称示例值： Guanzhaou-hxy-MS-CLB
ClusterType	是	否	String	集群类型，如TGW，STGW，VPCGW 示例值： STGW
ClusterTag	是	是	String	集群标签，只有STGW集群有标签示例值： TEST-FOR-XXX
Zone	是	否	String	集群所在可用区，如ap-guangzhou-1 示例值： ap-guangzhou-1
Network	是	否	String	集群网络类型，如Public，Private 示例值： Public
MaxConn	是	是	Int64	最大连接数示例值： 0
MaxInFlow	是	是	Int64	最大入带宽示例值： 0
MaxInPkg	是	是	Int64	最大入包量示例值： 0
MaxOutFlow	是	是	Int64	最大出带宽示例值： 0
MaxOutPkg	是	是	Int64	最大出包量示例值： 0
MaxNewConn	是	是	Int64	最大新建连接数示例值： 0
HTTPMaxNewConn	是	是	Int64	http最大新建连接数示例值： 0
HTTPSMaxNewConn	是	是	Int64	https最大新建连接数示例值： 0
HTTPQps	是	是	Int64	http QPS 示例值： 0
HTTPSQps	是	是	Int64	https QPS 示例值： 0
ResourceCount	是	否	Int64	集群内资源总数目示例值： 0
IdleResourceCount	是	是	Int64	集群内空闲资源数目示例值： 0
LoadBalanceDirectorCount	是	是	Int64	集群内转发机的数目示例值： 4
Isp	是	是	String	集群的Isp属性，如："BGP","CMCC","CUCC","CTCC","INTERNAL"。示例值： BGP

CertificateOutput

证书相关信息

被如下接口引用：DescribeListeners、DescribeRewrite

名称	必选	允许NULL	类型	描述
SSLMode	是	否	String	认证类型，UNIDIRECTIONAL：单向认证，MUTUAL：双向认证示例值： UNIDIRECTIONAL
CertId	是	否	String	服务端证书的 ID。(兼容早期版本，默认RSA证书) 示例值： ALZ****p
CertCaId	是	是	String	客户端证书的 ID。示例值： 4Ih****6
SmCertId	是	是	String	服务端SM证书的 ID。示例值： fds2dgsx
EccCertId	是	是	String	服务端ECC证书的 ID。示例值： fds2dgsx

InternetAccessible

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

被如下接口引用：CreateLoadBalancer、DescribeLoadBalancerListByCertId、DescribeLoadBalancers、DescribeLoadBalancersForVpc、InquiryPriceCreateLoadBalancer、InquiryPriceModifyLoadBalancer、ModifyLoadBalancerAttributes

名称	必选	允许NULL	类型	描述
InternetChargeType	否	是	String	TRAFFIC_POSTPAID_BY_HOUR 按流量按小时后计费 ; BANDWIDTH_POSTPAID_BY_HOUR 按带宽按小时后计费; BANDWIDTH_PACKAGE 按带宽包计费（当前，只有指定运营商时才支持此种计费模式）示例值： BANDWIDTH_POSTPAID_BY_HOUR
InternetMaxBandwidthOut	否	是	Int64	最大出带宽，单位Mbps，范围支持0到65535，仅对公网属性的LB生效，默认值 10 示例值： 1
BandwidthpkgSubType	否	是	String	带宽包的类型，如SINGLEISP 示例值： SINGLEISP

LoadBalanceListenerIds

创建的负载均衡以及对应的监听器信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
LoadBalancerId	是	否	String	负载均衡ID 示例值： lb-xxxxxx
ListenerIds	是	否	Array of String	监听器ID数组示例值： ["lbl-xxxxxxx"]

RewriteLocationMap

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

被如下接口引用：DeleteRewrite、ManualRewrite

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

QuotaData

主账号及子账号配额描述

被如下接口引用：DescribeSubUinQuotas

名称	必选	允许NULL	类型	描述
Type	是	否	Int64	配额类型（4:公网实例配额；7:内网实例配额）示例值： 4
UsedQuota	是	否	Int64	已使用配额示例值： 1
CurQuota	是	否	Int64	主账号配额示例值： 3
SubQuota	是	是	Array of SubQuotaRsp	该类型的子账号配额列表示例值：查看
SubUsedTotalQuota	是	是	Int64	子账户使用配额总和示例值： 5

SnatIp

SnatIp的信息结构

被如下接口引用：DescribeLoadBalancerListByCertId、DescribeLoadBalancers、DescribeLoadBalancersForVpc

名称	必选	允许NULL	类型	描述
SubnetId	是	否	String	私有网络子网的唯一性id，如subnet-12345678 示例值： 432
Ip	否	否	String	IP地址，如192.168.0.1 示例值： 1.1.1.1

CLBWhiteList

查询用户whiteList白名单返回

被如下接口引用：DescribeWhiteListSupport

名称	必选	允许NULL	类型	描述
WhiteListKey	是	否	String	白名单关键字示例值： IPv6_dualStack
WhiteListValue	是	否	Array of String	白名单值示例值： 1270000001

Listener

监听器的信息

被如下接口引用：DescribeListeners

名称	必选	允许NULL	类型	描述
ListenerId	是	否	String	负载均衡监听器 ID 示例值： lbl-odt45qxx
Protocol	是	否	String	监听器协议示例值： HTTP
ProtocolFake	否	否	String	监听器协议(Fake) 示例值： TCP
Port	是	否	Int64	监听器端口示例值： 80
Certificate	是	是	CertificateOutput	监听器绑定的证书信息示例值：查看
HealthCheck	是	是	HealthCheck	监听器的健康检查信息示例值：查看
Scheduler	是	是	String	请求的调度方式示例值： WRR
SessionExpireTime	是	是	Int64	会话保持时间示例值： 0
SniSwitch	是	是	Int64	是否开启SNI特性（本参数仅对于HTTPS监听器有意义）示例值： 0
Rules	是	是	Array of RuleOutput	监听器下的全部转发规则（本参数仅对于HTTP/HTTPS监听器有意义）示例值：查看
ListenerName	是	是	String	监听器的名称示例值： Name
CreateTime	是	是	String	监听器的创建时间。示例值： 2021-03-01 15:27:04
EndPort	是	是	Int64	端口段结束端口示例值： 0
TargetType	是	是	String	后端服务器类型示例值： NODE
TargetGroup	是	是	BasicTargetGroupInfo	绑定的目标组基本信息；当监听器绑定目标组时，会返回该字段示例值：查看
DefaultSerSwitch	是	是	Uint64	监听器是否开启设置默认域名标识，0为未开启；1为开启示例值： 0
DeregisterTargetRst	是	是	Bool	解绑后端目标时，是否发RST给客户端，（此参数仅对于TCP监听器有意义）。示例值： false
Toa	是	是	Bool	仅支持Nat64 CLB TCP监听器示例值： false
SessionType	否	是	String	会话保持类型。NORMAL表示默认会话保持类型。QUIC_CID 表示根据Quic Connection ID做会话保持。示例值： NORMAL
KeepaliveEnable	否	是	Int64	是否开启长连接，1开启，0关闭，（本参数仅对于HTTP/HTTPS监听器有意义）示例值： 0

ListenerBackend

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

被如下接口引用：DescribeTargets

名称	必选	允许NULL	类型	描述
ListenerId	是	否	String	监听器 ID 示例值： lbl-xxxxxxxx
Protocol	是	否	String	监听器的协议示例值： TCP
Port	是	否	Int64	监听器的端口示例值： 80
Rules	是	是	Array of RuleTargets	监听器下的规则信息（仅适用于HTTP/HTTPS监听器）示例值：查看
Targets	是	是	Array of Backend	监听器上绑定的后端服务列表（仅适用于TCP/UDP/TCP_SSL监听器）示例值：查看
EndPort	否	是	Int64	若支持端口段，则为端口段结束端口；若不支持端口段，则为0 示例值： 80

VipType

vip所属负载均衡类型

被如下接口引用：

名称	必选	允许NULL	类型	描述
Vip	是	否	String	vip 示例值： 1.1.1.1
Forward	是	否	Int64	负载均衡类型。1 应用型，0 传统型。示例值： 1

LoadBalancerLocationRule

创建规则的信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
LoadBalancerId	是	否	String	负载均衡ID 示例值： lb-xxxxxxx
ListenerId	是	否	String	监听器ID 示例值： lbl-xxxxxxx
LocationRules	是	否	Array of LocationRule	规则信息示例值：查看

SetVip

独占集群中Vip的使用信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
SetName	是	否	String	集群名字示例值： l4-set
UsedVip	是	是	Array of String	已使用的vip 示例值： 1.1.1.1
UnuseVip	是	是	Array of String	未使用vip 示例值： 2.2.2.2

SlaItem

性能保障规格参数。

被如下接口引用：

名称	必选	允许NULL	类型	描述
SlaType	是	否	String	性能保障规格类型示例值： clb.c1.small
SlaName	是	是	String	性能保障规格名字示例值：简约型
MaxConn	是	否	Uint64	最大连接数示例值： 5000
MaxCps	是	否	Uint64	最大新增连接数示例值： 3000
MaxOutBits	是	否	Uint64	最大出带宽。单位：bps 示例值： 200
MaxInBits	是	否	Uint64	最大入带宽。单位：bps 示例值： 200
MaxQps	是	否	Uint64	最大QPS 示例值： 1000

SubQuota

子账号配额描述

被如下接口引用：SetSubUinQuotas

名称	必选	允许NULL	类型	描述
SubUin	是	否	String	子账号Uin 示例值： 110000004918
Type	是	否	Uint64	配额类型（4:公网实例配额；7:内网实例配额）示例值： 4
Quota	是	否	Uint64	配额值示例值： 10

ClassicalListener

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

被如下接口引用：

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

LoadBalancerIdPair

关联操作的两个负载均衡类型

被如下接口引用：

名称	必选	允许NULL	类型	描述
SrcId	是	否	String	源负载均衡ID 示例值： lb-xxxxxxxx
DstId	是	否	String	目的负载均衡ID 示例值： lb-xxxxxxxx

RuleHealth

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

被如下接口引用：DescribeTargetHealth

名称	必选	允许NULL	类型	描述
LocationId	是	否	String	转发规则ID 示例值： loc-xxxxxxxx
Domain	是	是	String	转发规则的域名示例值： foo.net
Url	是	是	String	转发规则的Url 示例值： /test
Targets	是	是	Array of TargetHealth	本规则上绑定的后端的健康检查状态示例值：查看
FunctionTargets	否	是	Array of FunctionTarget	后端云函数的信息（TCE暂不支持）示例值：查看

RuleOutput

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

被如下接口引用：DescribeListeners、DescribeRewrite

名称	必选	允许NULL	类型	描述
LocationId	否	否	String	转发规则的 ID 示例值： loc-xxx
Domain	是	是	String	转发规则的域名。示例值： www.xxxx.com
Url	是	是	String	转发规则的路径。示例值： /test
SessionExpireTime	否	否	Int64	会话保持时间示例值： 0
HealthCheck	否	是	HealthCheck	健康检查信息示例值：查看
Certificate	否	是	CertificateOutput	证书信息示例值：查看
Scheduler	否	否	String	规则的请求转发方式示例值： WRR
ListenerId	是	否	String	转发规则所属的监听器 ID 示例值： lbl-8cnl****
RewriteTarget	是	是	RewriteTarget	转发规则的重定向目标信息示例值：查看
HttpGzip	是	否	Bool	是否开启gzip 示例值： true
BeAutoCreated	是	否	Bool	转发规则是否为自动创建示例值： false
DefaultServer	是	否	Bool	是否作为默认域名示例值： true
Http2	是	否	Bool	是否开启Http2 示例值： false
ForwardType	是	否	String	负载均衡与后端服务之间的转发协议示例值： HTTP
CreateTime	是	否	String	转发规则的创建时间示例值： 2024-01-22 14:36:12
TargetType	是	否	String	后端服务器类型示例值： NODE
TargetGroup	是	是	BasicTargetGroupInfo	绑定的目标组基本信息；当规则绑定目标组时，会返回该字段示例值：查看
WafDomainId	是	是	String	WAF实例ID 示例值： ""
QuicStatus	否	是	String	QUIC状态示例值： QUIC_INACTIVE
TrpcCallee	否	是	String	TRPC被调服务器路由，ForwardType为TRPC时有效示例值： ""
TrpcFunc	否	是	String	TRPC调用服务接口，ForwardType为TRPC时有效示例值： ""

Price

表示负载均衡的价格

被如下接口引用：InquiryPriceCreateLoadBalancer、InquiryPriceModifyLoadBalancer

名称	必选	允许NULL	类型	描述
InstancePrice	是	是	ItemPrice	描述了实例价格。示例值：查看
BandwidthPrice	是	是	ItemPrice	描述了网络价格。示例值：查看

LbRsItem

查询类型

被如下接口引用：DescribeLBListeners

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

RewriteTarget

重定向目标的信息

被如下接口引用：DescribeListeners、DescribeRewrite

名称	必选	允许NULL	类型	描述
TargetListenerId	是	是	String	重定向目标的监听器ID 注意：此字段可能返回 null，表示无重定向。示例值： lbl-xxxxxxxx
TargetLocationId	是	是	String	重定向目标的转发规则ID 注意：此字段可能返回 null，表示无重定向。示例值： loc-xxxxxxxx
RewriteCode	是	是	Int64	重定向状态码示例值： 302
TakeUrl	是	是	Bool	重定向是否携带匹配的url 示例值： true
RewriteType	是	是	String	重定向类型，Manual: 手动重定向，Auto: 自动重定向示例值： Auto

TargetCountForLoadBalancer

负载均衡实例及其绑定的后端服务总数

被如下接口引用：DescribeTargetCountForLoadBalancers

名称	必选	允许NULL	类型	描述
LoadBalancerId	是	否	String	负载均衡ID 示例值： lb-xxxxxxxx
TargetCount	是	否	Uint64	负载均衡实例绑定的后端服务总数示例值： 2

Target

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

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

名称	必选	允许NULL	类型	描述
Type	否	是	String	后端服务的类型，可取：CVM（云服务器）、ENI（弹性网卡）、BMS（裸金属服务器）；作为入参时，目前本参数暂不生效。示例值： CVM
InstanceId	否	是	String	绑定CVM时需要传入此参数，代表CVM的唯一 ID，可通过 DescribeInstances 接口返回字段中的 InstanceId 字段获取。注意：参数 InstanceId 、 EniIp 、InstanceBmsId 只能传入一个且必须传入一个。示例值： ins-xxxxxxxx
Port	是	是	Int64	后端服务的监听端口示例值： 80
Weight	否	否	Int64	后端服务的转发权重，取值范围：[0, 100]，默认为 10。示例值： 10
EniIp	否	是	String	绑定弹性网卡时需要传入此参数，代表弹性网卡的IP，弹性网卡必须先绑定至CVM，然后才能绑定到负载均衡实例。注意：参数 InstanceId 、EniIp、InstanceBmsId只能传入一个且必须传入一个。注意：绑定弹性网卡需要先提交工单开白名单使用。示例值： x.x.x.x
InstanceBmsId	否	是	String	绑定BMS时需要传入此参数，代表BMS的唯一 ID，可通过BMS产品的DescribeInstances 接口返回字段中的 bmsId 字段获取。注意：参数 InstanceId 、 EniIp 、InstanceBmsId 只能传入一个且必须传入一个，不支持同时绑定bms和cvm或eni。示例值： bms-xxxxxxxxx

TargetGroupBackend

目标组绑定的后端服务器

被如下接口引用：

名称	必选	允许NULL	类型	描述
TargetGroupId	是	否	String	目标组ID 示例值： lbtg-5f37****
Type	是	否	String	后端服务的类型，可取：CVM、ENI（即将支持）示例值： CVM
InstanceId	是	否	String	后端服务的唯一 ID 示例值： ins-2bei****
Port	是	否	Uint64	后端服务的监听端口示例值： 80
Weight	是	否	Uint64	后端服务的转发权重，取值范围：[0, 100]，默认为 10。示例值： 10
PublicIpAddresses	是	是	Array of String	后端服务的外网 IP 示例值： [1.1.1.1]
PrivateIpAddresses	是	是	Array of String	后端服务的内网 IP 示例值： [2.2.2.2]
InstanceName	是	是	String	后端服务的实例名称示例值： testName
RegisteredTime	是	是	Datetime	后端服务被绑定的时间示例值： 2021-03-16 00:00:00
EniId	是	是	String	弹性网卡唯一ID 示例值： eni-jf7u****

Resource

资源详细信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
Isp	是	否	String	运营商信息，如"CMCC", "CUCC", "CTCC", "BGP", "INTERNAL"。示例值： CMCC
Type	是	否	Array of String	运营商内具体资源信息，如"CMCC", "CUCC", "CTCC", "BGP", "INTERNAL"。示例值： CMCC

RsWeightRule

修改节点权重的数据类型

被如下接口引用：BatchModifyTargetWeight

名称	必选	允许NULL	类型	描述
ListenerId	是	否	String	负载均衡监听器 ID 示例值： lb-cuxw****
LocationId	否	否	String	转发规则的ID，七层规则时需要此参数，4层规则不需要示例值： loc-o8cn****
Domain	否	否	String	目标规则的域名，提供LocationId参数时本参数不生效示例值： www.demo.example.com
Url	否	否	String	目标规则的URL，提供LocationId参数时本参数不生效示例值： /index
Targets	是	否	Array of Target	要修改权重的后端机器列表示例值：查看
Weight	否	否	Int64	后端服务新的转发权重，取值范围：0~100。示例值： 10

Quota

描述配额信息

被如下接口引用：DescribeLBActionLimit

名称	必选	允许NULL	类型	描述
QuotaId	是	否	String	配额名称示例值： TOTAL_OPEN_CLB_QUOTA
QuotaCurrent	是	是	Int64	使用数量示例值： null
QuotaLimit	是	否	Int64	配额数量示例值： 3

DomainAttributes

域名及其相关属性，如是否设为DefaultServer、是否开启Http2、关联的证书

被如下接口引用：

名称	必选	允许NULL	类型	描述
Domain	是	否	String	域名示例值： foo.net
DefaultServer	否	否	Bool	是否设为默认域名，默认值示例值： true
Http2	否	否	Bool	是否开启Http2，默认值示例值： false
Certificate	否	否	CertificateInput	监听器开启SNI的情况下，此域名所关联的证书。示例值：查看

ProjectInfo

证书项目项目

被如下接口引用：DescribeCerts

名称	必选	允许NULL	类型	描述
ProjectId	是	否	String	项目ID 示例值： xxxxxxxx
OwnerUin	是	否	String	项目所有人示例值： 110000004918
Name	是	否	String	项目名称示例值： pj1
CreatorUin	是	否	String	创建者示例值： 110000004918
CreateTime	是	否	String	创建时间示例值： 2014-08-03 12:00:00
Info	是	否	String	项目信息示例值： test

TargetHealth

描述一个Target的健康信息

被如下接口引用：DescribeTargetHealth

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

ZoneSet

可用区信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
Master	是	是	Bool	是否为主可用区示例值： 1
ZoneId	是	是	Int64	可用区数值形式的唯一ID，如：100001 示例值： 6001001
Zone	是	是	String	可用区字符串形式的唯一ID，如：ap-guangzhou-1 示例值： zone1
ZoneName	是	是	String	可用区名称，如：广州一区示例值： zone1

CustomizedConfig

个性化配置信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
ConfigId	是	否	String	个性化配置ID 示例值： pz-xxxxxxxx
ConfigName	是	否	String	个性化配置名称示例值： test-config
ConfigContent	是	否	String	个性化配置内容示例值： add_header aaa bbb;\r\nxxxxxxxx
LoadBalancerIds	是	否	Array of String	个性化配置绑定的负载均衡示例值： ["lb-xxxxxxxx"]
AddTimestamp	是	否	Datetime	配置的添加时间示例值： 1700276322
ModTimestamp	是	否	Datetime	配置的最后更新时间示例值： 1700276322

LoadBalancer

负载均衡实例的信息

被如下接口引用：DescribeLoadBalancerListByCertId、DescribeLoadBalancers、DescribeLoadBalancersForVpc

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

SubQuotaRsp

查询子账号配额返回描述

被如下接口引用：DescribeSubUinQuotas

名称	必选	允许NULL	类型	描述
SubUin	是	否	String	子账号Uin 示例值： 110000004918
UsedQuota	是	否	Int64	子账号已使用配额示例值： 1
CurQuota	是	否	Int64	子账号当前配额示例值： 4
LastSetTime	是	否	String	子账号修改时间示例值： 2014-08-03 12:00:00

Backend

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

被如下接口引用：DescribeTargets

名称	必选	允许NULL	类型	描述
Type	是	否	String	后端服务的类型，可取：CVM、BMS、ENI 示例值： CVM
InstanceId	是	否	String	后端服务的唯一 ID，如 ins-abcd1234 示例值： ins-abcd1234
Port	是	否	Int64	后端服务的监听端口示例值： 80
Weight	是	否	Int64	后端服务的转发权重，取值范围：[0, 100]，默认为 10。示例值： 10
PublicIpAddresses	是	是	Array of String	后端服务的外网 IP 示例值： 1.1.1.1
PrivateIpAddresses	是	是	Array of String	后端服务的内网 IP 示例值： 10.0.0.1
InstanceName	是	是	String	后端服务的实例名称示例值： test-cvm
RegisteredTime	是	是	String	后端服务被绑定的时间示例值： 2021-12-29 14:38:50
EniId	是	是	String	弹性网卡唯一ID，如 eni-1234abcd 示例值： eni-1234abcd

ListenerRule

4层规则及后端服务器信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
HealthCheck	否	否	HealthCheck	健康健康配置示例值：查看
Scheduler	否	否	String	规则的请求转发方式，可选值：WRR、LEAST_CONN、IP_HASH 分别表示按权重轮询、最小连接数、按IP哈希，默认为 WRR。示例值： LEAST_CONN
SessionExpireTime	否	否	Uint64	会话保持时间。设置为0表示关闭会话保持，开启会话保持可取值30~3600，单位：秒。示例值： 3600
TargetType	否	否	String	后端目标类型，NODE表示绑定普通节点，TARGETGROUP表示绑定目标组示例值： NODE
TargetGroupId	否	否	String	目标组ID 示例值： tg-xxxxxxx
Targets	否	否	Array of Target	待绑定的后端服务列表，数组长度最大支持20 示例值：查看

SetItem

集群参数。

被如下接口引用：

名称	必选	允许NULL	类型	描述
SetId	是	否	Int64	集群Id 示例值： 3
SetName	是	否	String	集群名字示例值： l4-inner
Type	是	否	String	集群类型示例值： INNER
SetTag	是	是	String	集群标签示例值： xxxxx
MaxConn	是	否	Int64	最大连接数示例值： 100000000
MaxInFlow	是	否	Int64	最大入带宽示例值： 100000000
MaxInPkg	是	否	Int64	最大入包量示例值： 100000000
MaxOutFlow	是	否	Int64	最大出带宽示例值： 100000000
MaxOutPkg	是	否	Int64	最大出包量示例值： 100000000
MaxNewConn	是	是	Int64	最大新建连接数示例值： 100000000
HTTPMaxNewConn	是	是	Int64	http最大新建连接数示例值： 100000000
HTTPSMaxNewConn	是	是	Int64	https最大新建连接数示例值： 100000000
HTTPQps	是	是	Int64	http QPS 示例值： 100000000
HTTPSQps	是	是	Int64	https QPS 示例值： 100000000
Vips	是	是	Array of VipType	集群已使用vip 示例值：查看
ClusterId	是	是	String	集群Id 示例值： cluster-xxxxxxx

BindConfigItem

配置绑定关系，含配置ID。

被如下接口引用：

名称	必选	允许NULL	类型	描述
UconfigId	是	否	String	配置ID 示例值： pz-h98ds***
LoadBalancerId	是	否	String	配置绑定的CLB ID 示例值： lb-4d2y****
ListenerId	是	否	String	配置绑定的监听器ID 示例值： lbl-4apy****
Domain	是	否	String	配置绑定的域名示例值： boo.net
LocationId	是	是	String	配置绑定的规则示例值： loc-jdhs****

CertIdRelatedWithLoadBalancers

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

被如下接口引用：DescribeLoadBalancerListByCertId

名称	必选	允许NULL	类型	描述
CertId	是	否	String	证书ID 示例值： j9sl3xs2
LoadBalancers	是	是	Array of LoadBalancer	与证书关联的负载均衡实例列表示例值：查看

ListenerAttribute

创建监听器包含的属性信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
Protocol	是	否	String	监听器协议： TCP
Port	是	否	Uint64	端口号示例值： 80
ListenerName	否	否	String	监听器名称示例值： test
SniSwitch	否	否	String	是否开启SNI特性，此参数仅适用于HTTPS监听器。取值"ON"或者"OFF" 示例值： ON
Certificate	否	否	CertificateInput	证书相关信息，此参数仅适用于TCP_SSL监听器或者不开启SNI特性的HTTPS监听器示例值：查看
LocationRules	否	否	Array of LocationRule	七层监听器的规则信息示例值：查看
ListenerRule	否	否	ListenerRule	四层规则的信息示例值：查看

ListenerHealth

监听器的健康检查信息

被如下接口引用：DescribeTargetHealth

名称	必选	允许NULL	类型	描述
ListenerId	是	否	String	监听器ID 示例值： lbl-xxxxxxxx
ListenerName	是	是	String	监听器名称示例值： test
Protocol	是	否	String	监听器的协议示例值： TCP
Port	是	否	Int64	监听器的端口示例值： 80
Rules	是	是	Array of RuleHealth	监听器的转发规则列表示例值：查看

MasterZoneInfo

主可用区相关信息

被如下接口引用：DescribeMasterZones

名称	必选	允许NULL	类型	描述
ZoneId	是	是	Uint64	可用区数值形式的唯一ID，如：100001 示例值： 50010001
Zone	是	是	String	可用区字符串形式的唯一ID，如：ap-guangzhou-1 示例值： 50010001
ZoneName	是	是	String	可用区名称，如：广州一区示例值： 50010001
BackupZoneSet	是	是	Array of ZoneInfo	备可用区列表示例值：查看

FunctionTarget

SCF云函数（Serverless Cloud Function）作为后端服务

被如下接口引用：DescribeTargetHealth、DescribeTargets

名称	必选	允许NULL	类型	描述
Function	否	是	FunctionInfo	云函数相关信息示例值：查看
Weight	否	是	Uint64	权重示例值： 100

BindDetailItem

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

被如下接口引用：DescribeCustomizedConfigAssociateList

名称	必选	允许NULL	类型	描述
LoadBalancerId	是	否	String	配置绑定的CLB ID 示例值： lb-4d2y****
ListenerId	是	是	String	配置绑定的监听器ID 示例值： lbl-4apy****
Domain	是	是	String	配置绑定的域名示例值： foo.net
LocationId	是	是	String	配置绑定的规则示例值： loc-jdhs****
ListenerName	是	是	String	监听器名字示例值： test
Protocol	是	是	String	监听器协议示例值： HTTP
Vport	是	是	Int64	监听器端口示例值： 80
Url	是	是	String	location的url 示例值： /test
UconfigId	是	是	String	配置ID 示例值： pz-h98ds***

FunctionInfo

SCF云函数（Serverless Cloud Function）相关信息。

被如下接口引用：DescribeTargetHealth、DescribeTargets

名称	必选	允许NULL	类型	描述
FunctionNamespace	否	是	String	函数命名空间示例值： tce
FunctionName	否	是	String	函数名称示例值： test-function
FunctionQualifier	否	是	String	函数的版本名称或别名示例值： xxxxxx
FunctionQualifierType	否	是	String	标识 FunctionQualifier 参数的类型，可取值： VERSION（版本）、ALIAS（别名）示例值： xxxxx

RulesItems

七层规则对象

被如下接口引用：DescribeLBListeners

名称	必选	允许NULL	类型	描述
LocationId	是	否	String	规则id 示例值： loc-xxxxxxxx
Domain	是	否	String	域名示例值： foo.net
Url	是	否	String	uri 示例值： /test
Targets	是	否	Array of LbRsTargets	绑定的后端对象示例值：查看

SetNameItem

集群中英文名

被如下接口引用：DescribeSetInnerName

名称	必选	允许NULL	类型	描述
SetName	是	否	String	集群对外名字示例值： l4-set
SetChName	是	否	String	集群对内名字示例值： l4-set
ClusterId	是	是	String	集群ID 示例值： cluster-xxxxxxx

BlockedIP

加入了12306黑名单的IP

被如下接口引用：DescribeBlockIPList

名称	必选	允许NULL	类型	描述
IP	是	否	String	黑名单IP 示例值： 1.1.1.1
CreateTime	是	否	String	加入黑名单的时间示例值： 2024-10-20 12:00:00
ExpireTime	是	否	String	过期时间示例值： 2025-10-20 12:00:00

LoadBalancerPriceInfo

负载均衡费用信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
UnitPrice	是	是	Float	后付费价格，单位为元，示例值： 10.0
ChargePeriod	是	是	String	后付费计费周期示例值： HOUR
OriginalPrice	是	是	Float	预付费折前价格示例值： 10.0
DiscountPrice	是	是	Float	预付费折后价格示例值： 9.0