数据结构

最近更新时间:2019-05-14 17:03:36

Backend

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

被如下接口引用:DescribeTargets。

名称 类型 描述
Type String 转发目标的类型,目前仅可取值为 CVM
InstanceId String 云服务器的唯一 ID,可通过 DescribeInstances 接口返回字段中的 unInstanceId 字段获取
Port Integer 后端云服务器监听端口
Weight Integer 后端云服务器的转发权重,取值范围:0~100,默认为 10。
PublicIpAddresses Array of String 云服务器的外网 IP
注意:此字段可能返回 null,表示取不到有效值。
PrivateIpAddresses Array of String 云服务器的内网 IP
注意:此字段可能返回 null,表示取不到有效值。
InstanceName String 云服务器实例名称
注意:此字段可能返回 null,表示取不到有效值。
RegisteredTime String 云服务器被绑定到监听器的时间
注意:此字段可能返回 null,表示取不到有效值。

CertificateInput

证书信息

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

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

CertificateOutput

证书相关信息

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

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

ClassicalHealth

传统型负载均衡健康状态信息

被如下接口引用:DescribeClassicalLBHealthStatus。

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

ClassicalListener

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

被如下接口引用:DescribeClassicalLBListeners。

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

ClassicalLoadBalancerInfo

负载均衡信息

被如下接口引用:DescribeClassicalLBByInstanceId。

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

ClassicalTarget

传统型负载均衡后端信息

被如下接口引用:DescribeClassicalLBTargets。

名称 类型 描述
Type String 转发目标的类型,目前仅可取值为 CVM
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

HealthCheck

健康检查信息

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

名称 类型 必选 描述
HealthSwitch Integer 是否开启健康检查:1(开启)、0(关闭)。
TimeOut Integer 健康检查的响应超时时间,可选值:2~60,默认值:2,单位:秒。响应超时时间要小于检查间隔时间。
注意:此字段可能返回 null,表示取不到有效值。
IntervalTime Integer 健康检查探测间隔时间,默认值:5,可选值:5~300,单位:秒。
注意:此字段可能返回 null,表示取不到有效值。
HealthNum Integer 健康阈值,默认值:3,表示当连续探测三次健康则表示该转发正常,可选值:2~10,单位:次。
注意:此字段可能返回 null,表示取不到有效值。
UnHealthNum Integer 不健康阈值,默认值:3,表示当连续探测三次不健康则表示该转发异常,可选值:2~10,单位:次。
注意:此字段可能返回 null,表示取不到有效值。
HttpCode Integer 健康检查状态码(仅适用于HTTP/HTTPS转发规则)。可选值:1~31,默认 31。
1 表示探测后返回值 1xx 表示健康,2 表示返回 2xx 表示健康,4 表示返回 3xx 表示健康,8 表示返回 4xx 表示健康,16 表示返回 5xx 表示健康。若希望多种码都表示健康,则将相应的值相加。
注意:此字段可能返回 null,表示取不到有效值。
HttpCheckPath String 健康检查路径(仅适用于HTTP/HTTPS转发规则)。
注意:此字段可能返回 null,表示取不到有效值。
HttpCheckDomain String 健康检查域名(仅适用于HTTP/HTTPS转发规则)。
注意:此字段可能返回 null,表示取不到有效值。
HttpCheckMethod String 健康检查方法(仅适用于HTTP/HTTPS转发规则),取值为HEAD或GET。
注意:此字段可能返回 null,表示取不到有效值。

Listener

监听器的信息

被如下接口引用:DescribeListeners。

名称 类型 描述
ListenerId String 应用型负载均衡监听器 ID
Protocol String 监听器协议
Port Integer 监听器端口
Certificate CertificateOutput 监听器绑定的证书信息
注意:此字段可能返回 null,表示取不到有效值。
HealthCheck HealthCheck 监听器的健康检查信息
注意:此字段可能返回 null,表示取不到有效值。
Scheduler String 请求的调度方式
注意:此字段可能返回 null,表示取不到有效值。
SessionExpireTime Integer 会话保持时间
注意:此字段可能返回 null,表示取不到有效值。
SniSwitch Integer 是否开启SNI特性(本参数仅对于HTTPS监听器有意义)
注意:此字段可能返回 null,表示取不到有效值。
Rules Array of RuleOutput 监听器下的全部转发规则(本参数仅对于HTTP/HTTPS监听器有意义)
注意:此字段可能返回 null,表示取不到有效值。
ListenerName String 监听器的名称
注意:此字段可能返回 null,表示取不到有效值。

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

ListenerHealth

监听器的健康检查信息

被如下接口引用:DescribeTargetHealth。

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

LoadBalancer

负载均衡实例的信息

被如下接口引用:DescribeLoadBalancers。

名称 类型 必选 描述
LoadBalancerId String 负载均衡实例 ID。
LoadBalancerName String 负载均衡实例的名称。
LoadBalancerType String 负载均衡实例的网络类型:
OPEN:公网属性, INTERNAL:内网属性。
Forward Integer 应用型负载均衡标识,1:应用型负载均衡,0:传统型的负载均衡。
Domain String 负载均衡实例的域名,内网类型负载均衡以及应用型负载均衡实例不提供该字段
注意:此字段可能返回 null,表示取不到有效值。
LoadBalancerVips Array of String 负载均衡实例的 VIP 列表。
注意:此字段可能返回 null,表示取不到有效值。
Status Integer 负载均衡实例的状态,包括
0:创建中,1:正常运行。
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 负载均衡实例的创建时间。
注意:此字段可能返回 null,表示取不到有效值。
StatusTime String 负载均衡实例的上次状态转换时间。
注意:此字段可能返回 null,表示取不到有效值。
ProjectId Integer 负载均衡实例所属的项目 ID, 0 表示默认项目。
VpcId String 私有网络的 ID
注意:此字段可能返回 null,表示取不到有效值。
OpenBgp Integer 高防 LB 的标识,1:高防负载均衡 0:非高防负载均衡。
注意:此字段可能返回 null,表示取不到有效值。
Snat Boolean 在 2016 年 12 月份之前的传统型内网负载均衡都是开启了 snat 的。
注意:此字段可能返回 null,表示取不到有效值。
Isolation Integer 0:表示未被隔离,1:表示被隔离。
注意:此字段可能返回 null,表示取不到有效值。
Log String 用户开启日志的信息,日志只有公网属性创建了 HTTP 、HTTPS 监听器的负载均衡才会有日志。
注意:此字段可能返回 null,表示取不到有效值。
SubnetId String 负载均衡实例所在的子网(仅对内网VPC型LB有意义)
注意:此字段可能返回 null,表示取不到有效值。
Tags Array of TagInfo 负载均衡实例的标签信息
注意:此字段可能返回 null,表示取不到有效值。
SecureGroups Array of String 负载均衡实例的安全组
注意:此字段可能返回 null,表示取不到有效值。
TargetRegionInfo TargetRegionInfo 负载均衡实例绑定的后端设备的基本信息
注意:此字段可能返回 null,表示取不到有效值。
AnycastZone String anycast负载均衡的发布域,对于非anycast的负载均衡,此字段返回为空字符串
注意:此字段可能返回 null,表示取不到有效值。
AddressIPVersion String IP版本,ipv4 | ipv6
注意:此字段可能返回 null,表示取不到有效值。
NumericalVpcId Integer 数值形式的私有网络 ID
注意:此字段可能返回 null,表示取不到有效值。

LoadBalancerHealth

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

被如下接口引用:DescribeTargetHealth。

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

RewriteLocationMap

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

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

名称 类型 必选 描述
SourceLocationId String 源转发规则ID
TargetLocationId String 重定向至的目标转发规则ID

RewriteTarget

重定向目标的信息

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

名称 类型 描述
TargetListenerId String 重定向目标的监听器ID
注意:此字段可能返回 null,表示无重定向。
注意:此字段可能返回 null,表示取不到有效值。
TargetLocationId String 重定向目标的转发规则ID
注意:此字段可能返回 null,表示无重定向。
注意:此字段可能返回 null,表示取不到有效值。

RsWeightRule

修改节点权重的数据类型

被如下接口引用:BatchModifyTargetWeight。

名称 类型 必选 描述
ListenerId String 负载均衡监听器 ID
LocationId String 转发规则的ID
Targets Array of Target 要修改权重的后端机器列表
Domain String 目标规则的域名,提供LocationId参数时本参数不生效
Url String 目标规则的URL,提供LocationId参数时本参数不生效
Weight Integer 后端云服务器新的转发权重,取值范围:0~100。

RuleHealth

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

被如下接口引用:DescribeTargetHealth。

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

RuleInput

HTTP/HTTPS转发规则(输入)

被如下接口引用:CreateRule。

名称 类型 必选 描述
Domain String 转发规则的域名。
Url String 转发规则的路径。
SessionExpireTime Integer 会话保持时间
HealthCheck HealthCheck 健康检查信息
Certificate CertificateInput 证书信息
Scheduler String 规则的请求转发方式

RuleOutput

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

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

名称 类型 描述
LocationId String 转发规则的 ID
Domain String 转发规则的域名。
注意:此字段可能返回 null,表示取不到有效值。
Url String 转发规则的路径。
注意:此字段可能返回 null,表示取不到有效值。
SessionExpireTime Integer 会话保持时间
HealthCheck HealthCheck 健康检查信息
注意:此字段可能返回 null,表示取不到有效值。
Certificate CertificateOutput 证书信息
注意:此字段可能返回 null,表示取不到有效值。
Scheduler String 规则的请求转发方式
ListenerId String 转发规则所属的监听器 ID
RewriteTarget RewriteTarget 转发规则的重定向目标信息
注意:此字段可能返回 null,表示取不到有效值。
HttpGzip Boolean 是否开启gzip
BeAutoCreated Boolean 转发规则是否为自动创建
DefaultServer Boolean 是否作为默认域名
Http2 Boolean 是否开启Http2

RuleTargets

HTTP/HTTPS监听器下的转发规则的机器绑定信息

被如下接口引用:DescribeTargets。

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

TagInfo

负载均衡的标签信息

被如下接口引用:DescribeLoadBalancers。

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

Target

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

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

名称 类型 必选 描述
InstanceId String 云服务器的唯一 ID,可通过 DescribeInstances 接口返回字段中的 unInstanceId 字段获取
注意:此字段可能返回 null,表示取不到有效值。
Port Integer 后端云服务器监听端口
注意:此字段可能返回 null,表示取不到有效值。
Type String 转发目标的类型,目前仅可取值为 CVM
注意:此字段可能返回 null,表示取不到有效值。
Weight Integer 后端云服务器的转发权重,取值范围:0~100,默认为 10。

TargetHealth

描述一个Target的健康信息

被如下接口引用:DescribeTargetHealth。

名称 类型 描述
IP String Target的内网IP
Port Integer Target绑定的端口
HealthStatus Boolean 当前健康状态,true:健康,false:不健康。
TargetId String Target的实例ID,如 ins-12345678

TargetRegionInfo

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

被如下接口引用:DescribeLoadBalancers、ModifyLoadBalancerAttributes。

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