数据结构

最近更新时间: 2026-10-10 00:12:44

ConfigListItem

配置内容

被如下接口引用:DescribeCustomizedConfigList

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

LoadBalancerHealth

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

被如下接口引用:DescribeTargetHealth

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

QuotaData

主账号及子账号配额描述

被如下接口引用:DescribeSubUinQuotas

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

Quota

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

被如下接口引用:DescribeLBConfLimit、DescribeQuota

名称 必选 允许NULL 类型 描述
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_SNAT_IP_QUOTA: 一个CLB实例下跨地域2.0的SNAT IP配额 
  • TOTAL_ISP_CLB_QUOTA:用户当前地域下的三网CLB配额 
  • TOTAL_FULL_PORT_RANGE_LISTENER_QUOTA:一个CLB实例下的单个协议全端口段监听器配额

  • 示例值: TOTAL_OPEN_CLB_QUOTA
    QuotaCurrent 是 是 Int64 当前使用数量,为 null 时表示无意义。
    示例值: null
    QuotaLimit 是 否 Int64 配额数量。
    示例值: 3
    ResourceId 否 否 String 实例级别配额资源ID。
    示例值: lb-xxxxxxxx

    CertIdRelatedWithListener

    证书ID,以及该证书绑定的负载均衡监听器列表

    被如下接口引用:DescribeListenerListByCertId

    名称 必选 允许NULL 类型 描述
    CertId 是 否 String 证书ID
    示例值: j9djk23x
    Listeners 是 否 Array of CertListener 证书绑定的监听器列表
    示例值:查看

    LoadBalancer

    负载均衡实例的信息

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

    名称 必选 允许NULL 类型 描述
    LoadBalancerId 否 否 String 负载均衡实例 ID。
    示例值: lb-fwzz9i3x
    LoadBalancerName 否 否 String 负载均衡实例的名称。
    示例值: Name
    LoadBalancerType 否 否 String 负载均衡实例的网络类型:
    OPEN:公网属性, INTERNAL:内网属性。
    示例值: OPEN
    Forward 否 否 Uint64 负载均衡类型标识,1:负载均衡,0:传统型负载均衡。
    示例值: 1
    Domain 否 是 String 负载均衡实例的域名,仅公网传统型负载均衡实例才提供该字段
    示例值: www.aaa.com
    LoadBalancerVips 否 是 Array of String 负载均衡实例的 VIP 列表。
    示例值: [43.23.46.32]
    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-mj65xvs2
    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-lzj3cj09
    Tags 否 是 Array of TagInfo 负载均衡实例的标签信息
    示例值:查看
    SecureGroups 否 是 Array of String 负载均衡实例的安全组
    示例值: sg-hx6djv9x
    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-3985b4c5
    LogTopicId 否 是 String 负载均衡日志服务(CLS)的日志主题ID
    示例值: c32fc818-e984-414a-b8f5-3985b4c5
    AddressIPv6 否 是 String 负载均衡实例的IPv6地址
    示例值: 2402:4e00:1000:4e00:0:920b:5519:d96d
    ExtraInfo 否 是 ExtraInfo 暂做保留,一般用户无需关注。
    示例值:查看
    IsDDos 否 是 Bool 是否可绑定高防包
    示例值: false
    ConfigId 否 是 String 负载均衡维度的个性化配置ID
    示例值: pz-jdohxk30x
    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 私有云专用,clb实例绑定的四层集群标签
    示例值: ["l4-label"]
    StgwSetLabels 否 是 Array of String 私有云专用,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_L7
    ClusterIds 否 是 Array of String 7层独占集群ID。
    示例值: ["cluster-xkd9xk30"]
    VipIspAlias 否 是 String 负载均衡IP地址所属的ISP别名
    示例值: BGP

    TargetCountForLoadBalancer

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

    被如下接口引用:DescribeTargetCountForLoadBalancers

    名称 必选 允许NULL 类型 描述
    LoadBalancerId 是 否 String 负载均衡ID
    示例值: lb-di3kx902
    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-di3kx902
    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-di3kx902x

    LBChargePrepaid

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

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

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

    RuleInput

    HTTP/HTTPS转发规则(输入)

    被如下接口引用:CreateRule

    名称 必选 允许NULL 类型 描述
    Domain 是 否 String 转发规则的域名。长度限制为:1~80。
    示例值: www.realdomain.com
    Url 是 否 String 转发规则的路径。长度限制为:1~200。
    示例值: /local
    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

    SubQuota

    子账号配额描述

    被如下接口引用:SetSubUinQuotas

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

    BatchTarget

    批量绑定类型

    被如下接口引用:BatchDeregisterTargets、BatchRegisterTargets

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

    VipMode

    是否可以申请动态IP

    被如下接口引用:DescribeLBConfLimit

    名称 必选 允许NULL 类型 描述
    Open 是 否 Bool 允许申请2种IP模式。
    示例值: True
    Internal 是 否 Bool 不允许申请2种IP模式。
    示例值: False
    OpenDetail 是 是 String Dynamic 公网动态IP,
    STATIC 公网固定IP。Open为False时生效。
    示例值: Dynamic
    InternalDetail 是 是 String Dynamic 内网动态IP,
    STATIC 内网固定IP。Internal为False时生效。
    示例值: Dynamic

    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别名
    示例值: 移动

    ExtraInfo

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

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

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

    TypeInfo

    运营商类型信息

    被如下接口引用:DescribeResources

    名称 必选 允许NULL 类型 描述
    Type 是 否 String 运营商类型
    示例值: BGP
    SpecAvailabilitySet 是 否 Array of SpecAvailability 规格可用性
    示例值:查看

    MultiCertInfo

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

    被如下接口引用:CreateListener

    名称 必选 允许NULL 类型 描述
    SSLMode 是 否 String 认证类型,UNIDIRECTIONAL:单向认证,MUTUAL:双向认证
    示例值: UNIDIRECTIONAL
    CertList 是 否 Array of CertInfo 监听器或规则证书列表,单双向认证,多本服务端证书算法类型不能重复;若SSLMode为双向认证,证书列表必须包含一本ca证书。
    示例值:查看
    SSLVerifyClient 否 否 String 双向认证时,是否开启客户端认证,ON:开启,OPTIONAL:自适应,默认ON
    示例值: ON

    Resource

    资源详细信息

    被如下接口引用:DescribeResources

    名称 必选 允许NULL 类型 描述
    Type 是 否 Array of String 运营商内具体资源信息,如"CMCC", "CUCC", "CTCC", "BGP", "INTERNAL"。
    示例值: CMCC
    Isp 是 否 String 运营商信息,如"CMCC", "CUCC", "CTCC", "BGP", "INTERNAL"。
    示例值: CMCC
    AvailabilitySet 是 否 Array of ResourceAvailability 可用资源。
    示例值:查看
    TypeSet 是 否 Array of TypeInfo 运营商类型信息
    示例值:查看

    RewriteLocationMap

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

    被如下接口引用:DeleteRewrite、ManualRewrite

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

    RsWeightRule

    修改节点权重的数据类型

    被如下接口引用:BatchModifyTargetWeight

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

    ZoneInfo

    可用区相关信息

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

    名称 必选 允许NULL 类型 描述
    ZoneId 是 是 Uint64 可用区数值形式的唯一ID,如:100001
    示例值: 100001
    Zone 是 是 String 可用区字符串形式的唯一ID,如:ap-region1-1
    示例值: ap-region1-1
    ZoneName 是 是 String 可用区名称,如:可用区1
    示例值: 可用区1
    ZoneRegion 否 是 String 可用区所在地域
    示例值: ap-region1
    LocalZone 否 是 Bool 可用区是否是LocalZone可用区
    示例值: false
    EnableShared 否 是 Bool 可用区是否有共享集群可用
    示例值: true
    EnableL4SetLabels 否 是 Array of String 可用区可使用四层集群标签
    示例值: ["l4-label"]
    AvailableIsps 否 否 Array of AvailableIspInfo 可用区可使用运营商信息集合
    示例值:查看

    CertList

    租户端证书列表

    被如下接口引用:DescribeCerts

    名称 必选 允许NULL 类型 描述
    OwnerUin 是 否 String 所有者
    示例值: 110000004918
    ProjectId 是 否 String 项目ID
    示例值: 0
    From 是 否 String 证书来源
    示例值: upload
    CertType 是 否 String 产品类型
    示例值: SVR
    ProductZhName 是 否 String 产品名称
    示例值: zhangsan@gmail.com
    Domain 是 否 String 项目域名
    示例值: zhangsan@gmail.com
    Alias 是 否 String 证书备注或名称
    示例值: zhangsan1
    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-----\r\nMIIEjTCCA3WgAwIBAgIQA4ZHUAVO9c\r\nYOuRvokzVT4lsaln5LKkKxw=\r\n-----END CERTIFICATE-----\r\n
    SignCert 否 是 String 国密证书签名内容
    示例值: -----BEGIN CERTIFICATE-----\r\nMIIEjTCCA3W9c\r\nYOuRvokzVT4lsaln5LKkKxw=\r\n-----END CERTIFICATE-----\r\n
    SubjectAltName 是 是 Array of String 备用域名列表
    示例值: ["domain2.com"]
    CertAlgorithm 是 是 String 取值类型:rsa: ecc: sm2:  默认为 rsa
    示例值: rsa

    CertListener

    证书绑定的负载均衡监听器属性

    被如下接口引用:DescribeListenerListByCertId

    名称 必选 允许NULL 类型 描述
    ListenerId 否 否 String 负载均衡监听器 ID
    示例值: lbl-jd8k32x3
    ListenerName 否 否 String 监听器名称
    示例值: 监听器-门户网站
    LBId 否 否 String 负载均衡ID
    示例值: lb-jc8k3d0b
    Protocol 否 否 String 监听器协议
    示例值: TCP
    Port 否 否 Int64 监听器端口
    示例值: 80
    SSLMode 否 否 String 认证类型,UNIDIRECTIONAL:单向认证,MUTUAL:双向认证
    示例值: UNIDIRECTIONAL
    CertId 否 否 String 证书id
    示例值: j9djk23x
    CertCaId 否 否 String 客户端证书id
    示例值: j9djk23x
    SniSwitch 否 否 Int64 是否开启SNI特性(本参数仅对于HTTPS监听器有意义)
    示例值: 0
    AddTimestamp 否 否 String 监听器的创建时间。
    示例值: 2024-02-21 12:00:00

    RewriteTarget

    重定向目标的信息

    被如下接口引用:DescribeListeners、DescribeRewrite

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

    ResourceAvailability

    资源可用性

    被如下接口引用:DescribeResources

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

    CertIdRelatedWithLoadBalancers

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

    被如下接口引用:DescribeLoadBalancerListByCertId

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

    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,则此项必传。
    示例值: cert-1
    CertKey 否 否 String 上传服务端RSA证书的 key,如果没有 CertId,则此项必传。
    示例值: -----BEGIN RSA PRIVATE KEY-----\r\nji93cs\r\n-----END RSA PRIVATE KEY-----\r\n
    CertContent 否 否 String 上传服务端RSA证书的内容,如果没有 CertId,则此项必传。
    示例值: -----BEGIN CERTIFICATE-----\r\nMIIEjTCCA3W5LKkKxw=\r\n-----END CERTIFICATE-----\r\n
    CertCaName 否 否 String 上传客户端 CA 证书的名称,如果 SSLMode=mutual,如果没有 CertCaId,则此项必传。
    示例值: certca1
    CertCaContent 否 否 String 上传客户端证书的内容,如果 SSLMode=mutual,如果没有 CertCaId,则此项必传。
    示例值: -----BEGIN CERTIFICATE-----\r\nMIIEjTCCA3WgAwIBA9c\r\nYOuRvokzVT4lsaln5LKkKxw=\r\n-----END CERTIFICATE-----\r\n
    EccCertId 否 否 String 服务端ECC证书的 ID,如果不填写此项则必须上传证书,包括 CertContent,CertKey,CertName。
    示例值: xfdj3ghx
    EccCertName 否 否 String 上传服务端ECC证书的名称,如果没有 CertEccId,则此项必传。
    示例值: cert1
    EccCertContent 否 否 String 上传服务端ECC证书的内容,如果没有 CertEccId,则此项必传。
    示例值: -----BEGIN CERTIFICATE-----\r\nMIIEjTCCA3WgAwqdNY9c\r\nYOuRvokzVT4lsaln5LKkKxw=\r\n-----END CERTIFICATE-----\r\n
    EccCertKey 否 否 String 上传服务端ECC证书的key,如果没有 CertEccId,则此项必传。
    示例值: -----BEGIN RSA PRIVATE KEY-----\r\nji93fd\r\n-----END RSA PRIVATE KEY-----\r\n
    SmCertId 否 否 String 服务端国密SM证书的 ID,如果不填写此项则必须上传证书,包括 CertSMContent,CertSmKey,CertSMName,CertSMSignContent,CertSMSignKey。
    示例值: xfdj3ghx
    SmCertName 否 否 String 上传服务端国密SM证书的名称,如果没有 CertSMId,则此项必传。
    示例值: cert1
    SmCertSignContent 否 否 String 上传服务端国密SM证书的签名公约,如果没有 CertSMId,则此项必传。
    示例值: -----BEGIN CERTIFICATE-----\r\nji93\r\n-----END CERTIFICATE-----\r\n
    SmCertSignKey 否 否 String 上传服务端国密SM证书的签名密钥,如果没有 CertSMId,则此项必传。
    示例值: -----BEGIN RSA PRIVATE KEY-----\r\nji93df\r\n-----END RSA PRIVATE KEY-----\r\n
    SmCertContent 否 否 String 上传服务端国密SM证书的证书公约,如果没有 CertSMId,则此项必传。
    示例值: -----BEGIN CERTIFICATE-----\r\nji93\r\n-----END CERTIFICATE-----\r\n
    SmCertKey 否 否 String 上传服务端国密SM证书的证书密钥,如果没有 CertSMId,则此项必传。
    示例值: -----BEGIN RSA PRIVATE KEY-----\r\nji93fd\r\n-----END RSA PRIVATE KEY-----\r\n

    HealthCheck

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

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

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

    SnatIp

    SnatIp的信息结构

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

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

    ZoneResource

    可用区资源列表

    被如下接口引用:DescribeResources

    名称 必选 允许NULL 类型 描述
    ResourceSet 是 否 Array of Resource 资源列表。
    示例值:查看
    IPVersion 是 否 String IP版本,如IPv4,IPv6,IPv6_Nat。
    示例值: IPv4
    ZoneRegion 是 否 String 可用区所属地域,如:region1
    示例值: region1
    LocalZone 是 否 Bool 可用区是否是LocalZone可用区,如:false
    示例值: false
    ZoneResourceType 是 否 String 可用区资源的类型,SHARED表示共享资源,EXCLUSIVE表示独占资源。
    示例值: "SHARED"
    Egress 是 否 String 网络出口
    示例值: center_egress1
    MasterZone 是 否 String 主可用区,如"region1-1"。
    示例值: region1-2
    SlaveZone 是 是 String 备可用区,如"region1-2",单可用区时,备可用区为null。
    示例值: region1-3
    EdgeZone 是 否 Bool 可用区是否是EdgeZone可用区,如:false
    示例值: false

    SubQuotaRsp

    查询子账号配额返回描述

    被如下接口引用:DescribeSubUinQuotas

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

    RuleTargets

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

    被如下接口引用:DescribeTargets

    名称 必选 允许NULL 类型 描述
    LocationId 是 否 String 转发规则的 ID
    示例值: loc-i82kji93
    Domain 是 否 String 转发规则的域名
    示例值: wagnzha.com
    Url 是 否 String 转发规则的路径。
    示例值: /url1
    Targets 是 是 Array of Backend 后端服务的信息
    示例值:查看
    FunctionTargets 否 是 Array of FunctionTarget 后端云函数的信息(私有云暂不支持)
    示例值:查看

    AvailableIspInfo

    可用区运营商可使用情况

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

    名称 必选 允许NULL 类型 描述
    Isp 是 否 String 运营商
    示例值: 内网
    IspAlias 否 否 String 运营商别名
    示例值: 内网
    EnableShared 是 否 Bool 是否有共享集群资源
    示例值: true
    EnableL4SetLabels 否 否 Array of String 可使用的四层集群标签
    示例值: ["l4-label1"]
    AvailableVpcIds 否 否 Array of String IPv6-BGP模式可使用的VPC
    示例值: ["vpc-xh39xy45"]

    ExclusiveCluster

    独占集群

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

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

    SpecAvailability

    规格可用性

    被如下接口引用:DescribeResources

    名称 必选 允许NULL 类型 描述
    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(共享型)

  • 示例值: shared
    Availability 是 否 String 规格可用性。资源可用性,"Available":可用,"Unavailable":不可用
    示例值: Available

    Backend

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

    被如下接口引用:DescribeTargets

    名称 必选 允许NULL 类型 描述
    Type 是 否 String 后端服务的类型,可取:CVM、BMS、ENI
    示例值: CVM
    InstanceId 是 否 String 后端服务的唯一 ID,如 ins-gx3gj9x7
    示例值: ins-gx3gj9x7
    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 后端服务的实例名称
    示例值: cvm-1
    RegisteredTime 是 是 String 后端服务被绑定的时间
    示例值: 2021-12-29 14:38:50
    EniId 是 是 String 弹性网卡唯一ID,如 eni-j9x7gx3g
    示例值: eni-j9x7gx3g

    BindItem

    配置绑定关系

    被如下接口引用:AssociateCustomizedConfig

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

    MasterZoneInfo

    主可用区相关信息

    被如下接口引用:DescribeMasterZones

    名称 必选 允许NULL 类型 描述
    ZoneId 是 是 Uint64 可用区数值形式的唯一ID,如:100001
    示例值: 50010001
    Zone 是 是 String 可用区字符串形式的唯一ID,如:ap-region1-1
    示例值: 50010001
    ZoneName 是 是 String 可用区名称,如:可用区1
    示例值: 50010001
    BackupZoneSet 是 是 Array of ZoneInfo 备可用区列表
    示例值:查看
    LBType 否 是 String 返回的可用区类型,取值范围:open、internal
    示例值: open
    AvailableIsps 否 是 Array of AvailableIspInfo 返回的各个运营商可使用情况
    示例值:查看

    Price

    表示负载均衡的价格

    被如下接口引用:InquiryPriceCreateLoadBalancer、InquiryPriceModifyLoadBalancer

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

    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

    TagInfo

    负载均衡的标签信息

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

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

    FunctionTarget

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

    被如下接口引用:DescribeTargetHealth、DescribeTargets

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

    Listener

    监听器的信息

    被如下接口引用:DescribeListeners

    名称 必选 允许NULL 类型 描述
    AttrFlags 是 否 Array of String

    监听器的属性


    示例值: ["Stop"]
    RescheduleStartTime 否 否 Int64

    重新调度启动时间,配置了重新调度启动时间后,会在启动时间到达时触发重新调度。


    示例值: 600
    RescheduleInterval 否 否 Uint64

    重新调度触发持续时间,取值0~3600s。仅TCP/UDP监听器支持。触发重新调度后,长连接将会在设置的调度时间内断开并完成重新分配。

    单位:秒


    示例值: 600
    ListenerId 是 否 String 负载均衡监听器 ID
    示例值: lbl-odt45q4g
    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
    IdleConnectTimeout 否 是 Int64 空闲连接超时时间,此参数仅适用于TCP/UDP监听器。
    示例值: 0

    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

    OwnerLabel

    用户和标签对应关系

    被如下接口引用:DescribeAppIdLabel

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

    RegionItem

    地域信息

    被如下接口引用:DescribeRegions

    名称 必选 允许NULL 类型 描述
    RegionId 是 否 Uint64 地域ID,如1。
    示例值:
    RegionAbbreviation 是 否 String 地域缩写,如"gz"。
    示例值:
    Region 是 否 String 地域,如"region1"。
    示例值:

    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-j9x73ko1
    示例值: 'ins-j9x73ko1'
    HealthStatusDetial 是 否 String 当前健康状态的详细信息。如:Alive、Dead、Unknown。Alive状态为健康,Dead状态为异常,Unknown状态包括尚未开始探测、探测中、状态未知。
    示例值: 'Alive'
    HealthStatusDetail 否 否 String 当前健康状态的详细信息。如:Alive、Dead、Unknown。Alive状态为健康,Dead状态为异常,Unknown状态包括尚未开始探测、探测中、状态未知。
    示例值: 'Alive'

    TargetRegionInfo

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

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

    名称 必选 允许NULL 类型 描述
    Region 是 否 String Target所属地域,如 ap-region1
    示例值: ap-region1
    VpcId 是 否 String Target所属网络,私有网络格式如 vpc-gx3gj9x7,如果是基础网络,则为"0"
    示例值: vpc-6kogji93

    FunctionInfo

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

    被如下接口引用:DescribeTargetHealth、DescribeTargets

    名称 必选 允许NULL 类型 描述
    FunctionNamespace 否 是 String 函数命名空间
    示例值: default
    FunctionName 否 是 String 函数名称
    示例值: function-1
    FunctionQualifier 否 是 String 函数的版本名称或别名
    示例值: jd9x30xs
    FunctionQualifierType 否 是 String 标识 FunctionQualifier 参数的类型,可取值: VERSION(版本)、ALIAS(别名)
    示例值: VERSION

    ClusterItem

    独占集群信息

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

    名称 必选 允许NULL 类型 描述
    ClusterId 是 否 String 集群唯一ID
    示例值: cluste-jd9x30xs
    ClusterName 否 是 String 集群名称
    示例值: cluster-1
    Zone 否 是 String 集群所在可用区,如ap-region1-1
    示例值: ap-region1

    BindDetailItem

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

    被如下接口引用:DescribeCustomizedConfigAssociateList

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

    CertificateOutput

    证书相关信息

    被如下接口引用:DescribeListeners、DescribeRewrite

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

    ProjectInfo

    证书项目项目

    被如下接口引用:DescribeCerts

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

    RuleHealth

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

    被如下接口引用:DescribeTargetHealth

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

    Filter

    过滤器条件

    被如下接口引用:DescribeListeners、DescribeLoadBalancers、DescribeQuota、DescribeRegions、DescribeResources

    名称 必选 允许NULL 类型 描述
    Name 是 否 String 过滤器的名称
    示例值: tag-key
    Values 是 否 Array of String 过滤器的值数组
    示例值: ["tke-clusterId"]

    ListenerBackend

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

    被如下接口引用:DescribeTargets

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

    SlaItem

    性能保障规格参数。

    被如下接口引用:DescribeSlaCapacity

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

    ListenerHealth

    监听器的健康检查信息

    被如下接口引用:DescribeTargetHealth

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

    RuleOutput

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

    被如下接口引用:DescribeListeners、DescribeRewrite

    名称 必选 允许NULL 类型 描述
    LocationId 否 否 String 转发规则的 ID
    示例值: loc-jkdsix03
    Domain 是 是 String 转发规则的域名。
    示例值: www.realdomain.com
    Url 是 是 String 转发规则的路径。
    示例值: /url1
    SessionExpireTime 否 否 Int64 会话保持时间
    示例值: 0
    HealthCheck 否 是 HealthCheck 健康检查信息
    示例值:查看
    Certificate 否 是 CertificateOutput 证书信息
    示例值:查看
    Scheduler 否 否 String 规则的请求转发方式
    示例值: WRR
    ListenerId 是 否 String 转发规则所属的监听器 ID
    示例值: lbl-8cnlji93
    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时有效
    示例值: ""

    BasicTargetGroupInfo

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

    被如下接口引用:DescribeListeners、DescribeRewrite

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

    CertInfo

    证书信息

    被如下接口引用:CreateListener

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