BindL4Backend
待与四层监听器绑定的物理机主机、虚拟机或半托管主机信息。目前一个四层监听器下面最多允许绑定255个主机端口。
被如下接口引用:BindL4Backends。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Port | Integer | 是 | 待绑定的主机端口,可选值1~65535。 |
InstanceId | String | 是 | 待绑定的黑石物理机主机ID、虚拟机IP或者是半托管主机ID。 |
Weight | Integer | 是 | 待绑定的主机权重,可选值0~100。 |
ProbePort | Integer | 否 | 自定义探测的主机端口,可选值1~65535。(需要监听器开启自定义健康检查) |
BindL7Backend
待与七层监听器转发规则绑定的物理机主机、虚拟机或半托管主机信息。目前一个七层转发路径下面最多允许绑定255个主机端口。
被如下接口引用:BindL7Backends。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Port | Integer | 否 | 待绑定的主机端口,可选值1~65535。 |
InstanceId | String | 否 | 黑石物理机主机ID、虚拟机IP或者是半托管主机ID。 |
Weight | Integer | 否 | 待绑定的主机权重,可选值0~100。 |
BindTrafficMirrorReceiver
待与流量镜像绑定的接收机信息。
被如下接口引用:BindTrafficMirrorReceivers。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Port | Integer | 是 | 待绑定的主机端口,可选值1~65535。 |
InstanceId | String | 是 | 待绑定的主机实例ID。 |
Weight | Integer | 是 | 待绑定的主机权重,可选值0~100。 |
CertDetailLoadBalancer
获取证书信息时返回的所用在的负载均衡信息。
被如下接口引用:DescribeCertDetail。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
LoadBalancerId | String | 否 | 黑石负载均衡实例ID。 |
LoadBalancerName | String | 否 | 黑石负载均衡实例名称。 |
VpcId | String | 否 | 该黑石负载均衡所在的VpcId。 |
RegionId | Integer | 否 | 该黑石负载均衡所在的regionId。 |
CreateL4Listener
用于创建四层监听器的监听器信息。目前一个负载均衡下面最多允许创建50个监听器。
被如下接口引用:CreateL4Listeners。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
LoadBalancerPort | Integer | 是 | 监听器监听端口,可选值1~65535。 |
Protocol | String | 是 | 监听器协议类型,可选值tcp,udp。 |
ListenerName | String | 是 | 监听器名称。 |
SessionExpire | Integer | 否 | 监听器的会话保持时间,单位:秒。可选值:900~3600,不传表示不开启会话保持。 |
HealthSwitch | Integer | 否 | 是否开启健康检查:1(开启)、0(关闭)。默认值0,表示关闭。 |
TimeOut | Integer | 否 | 健康检查的响应超时时间,可选值:2-60,默认值:2,单位:秒。 响应超时时间要小于检查间隔时间。 |
IntervalTime | Integer | 否 | 健康检查检查间隔时间,默认值:5,可选值:5-300,单位:秒。 |
HealthNum | Integer | 否 | 健康阈值,默认值:3,表示当连续探测三次健康则表示该转发正常,可选值:2-10,单位:次。 |
UnhealthNum | Integer | 否 | 不健康阈值,默认值:3,表示当连续探测三次不健康则表示该转发不正常,可选值:2-10,单位:次。 |
Bandwidth | Integer | 否 | 监听器最大带宽值,用于计费模式为固定带宽计费,可选值:0-1000,单位:Mbps。 |
CustomHealthSwitch | Integer | 否 | 是否开启自定义健康检查:1(开启)、0(关闭)。默认值0,表示关闭。(该字段在健康检查开启的情况下才生效) |
InputType | String | 否 | 自定义健康探测内容类型,可选值:text(文本)、hexadecimal(十六进制)。 |
LineSeparatorType | Integer | 否 | 探测内容类型为文本方式时,针对请求文本中换行替换方式。可选值:1(替换为LF)、2(替换为CR)、3(替换为LF+CR)。 |
HealthRequest | String | 否 | 自定义探测请求内容。 |
HealthResponse | String | 否 | 自定义探测返回内容。 |
ToaFlag | Integer | 否 | 是否开启toa。可选值:0(关闭)、1(开启),默认关闭。(该字段在负载均衡为fullnat类型下才生效) |
CreateL7Listener
用于创建四层监听器的监听器信息。目前一个负载均衡下面最多允许创建50个七层监听器。
被如下接口引用:CreateL7Listeners。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
LoadBalancerPort | Integer | 是 | 七层监听器端口,可选值1~65535。 |
Protocol | String | 是 | 七层监听器协议类型,可选值:http,https。 |
ListenerName | String | 是 | 七层监听器名称。 |
SslMode | Integer | 否 | 认证方式:0(不认证,用于http),1(单向认证,用于https),2(双向认证,用于https)。当创建的是https类型的监听器时,此值必选。 |
CertId | String | 否 | 服务端证书ID。当创建的是https类型的监听器时,此值必选。 |
CertName | String | 否 | 服务端证书名称。 |
CertContent | String | 否 | 服务端证书内容。 |
CertKey | String | 否 | 服务端证书密钥。 |
CertCaId | String | 否 | 客户端证书ID。 |
CertCaName | String | 否 | 客户端证书名称。 |
CertCaContent | String | 否 | 客户端证书内容。 |
Bandwidth | Integer | 否 | 用于计费模式为固定带宽计费,指定监听器最大带宽值,可选值:0-1000,单位:Mbps。 |
ForwardProtocol | Integer | 否 | 转发协议。当Protocol为https时并且SslMode为1或2时,有意义。可选的值为0:https,1:spdy,2:http2,3:spdy+http2。 |
CreateL7Rule
用于创建七层监听器的转发规则的信息。目前一个七层监听器下面最多允许创建50个七层转发域名,而每一个转发域名下最多可以创建100个转发规则。
被如下接口引用:CreateL7Rules。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Domain | String | 是 | 七层转发规则的转发域名。 |
Url | String | 是 | 七层转发规则的转发路径。 |
SessionExpire | Integer | 否 | 会话保持时间,单位:秒。可选值:30~3600。默认值0,表示不开启会话保持。 |
HealthSwitch | Integer | 否 | 健康检查开关:1(开启)、0(关闭)。默认值0,表示关闭。 |
IntervalTime | Integer | 否 | 健康检查检查间隔时间,默认值:5,可选值:5-300,单位:秒。 |
HealthNum | Integer | 否 | 健康检查健康阈值,默认值:3,表示当连续探测三次健康则表示该转发正常,可选值:2-10,单位:次。 |
UnhealthNum | Integer | 否 | 健康检查不健康阈值,默认值:5,表示当连续探测五次不健康则表示该转发不正常,可选值:2-10,单位:次。 |
HttpCodes | Array of Integer | 否 | 健康检查中认为健康的HTTP返回码的组合。可选值为1~5的集合,1表示HTTP返回码为1xx认为健康。2表示HTTP返回码为2xx认为健康。3表示HTTP返回码为3xx认为健康。4表示HTTP返回码为4xx认为健康。5表示HTTP返回码为5xx认为健康。 |
HttpCheckPath | String | 否 | 健康检查检查路径。 |
HttpCheckDomain | String | 否 | 健康检查检查域名。如果创建规则的域名使用通配符或正则表达式,则健康检查检查域名可自定义,否则必须跟健康检查检查域名一样。 |
BalanceMode | String | 否 | 均衡方式:ip_hash、wrr。默认值wrr。 |
CreateLoadBalancerBzConf
用于创建负载均衡的个性化配置。
被如下接口引用:CreateLoadBalancers。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
BzPayMode | String | 否 | 按月/按小时计费。 |
BzL4Metrics | String | 否 | 四层可选按带宽,连接数衡量。 |
BzL7Metrics | String | 否 | 七层可选按qps衡量。 |
DescribeL4Backend
待查询四层监听器绑定的主机信息。
被如下接口引用:DescribeL4Backends。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Port | Integer | 否 | 待绑定的主机端口,可选值1~65535。 |
InstanceId | String | 否 | 黑石物理机的主机ID。 |
DescribeTrafficMirrorReceiver
流量镜像进行健康检查的接收机信息。
被如下接口引用:DescribeTrafficMirrorReceiverHealthStatus。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
InstanceId | String | 是 | 物理机实例ID。 |
Port | Integer | 是 | 物理机绑定的端口。 |
DevicesBindInfoBackend
获取设备绑定信息时返回的所绑定的主机信息。
被如下接口引用:DescribeDevicesBindInfo。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
InstanceId | String | 否 | 黑石物理机的主机ID、托管主机ID或虚拟机IP。 |
Port | Integer | 否 | 主机端口。 |
DevicesBindInfoL4Listener
获取设备绑定信息时返回的四层监听器信息。
被如下接口引用:DescribeDevicesBindInfo。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ListenerId | String | 否 | 七层监听器实例ID。 |
Protocol | String | 否 | 七层监听器协议类型,可选值:http,https。 |
LoadBalancerPort | Integer | 否 | 七层监听器的监听端口。 |
BackendSet | Array of DevicesBindInfoBackend | 否 | 该转发路径所绑定的主机列表。 |
DevicesBindInfoL7Listener
获取设备绑定信息时返回的七层监听器信息。
被如下接口引用:DescribeDevicesBindInfo。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ListenerId | String | 否 | 七层监听器实例ID。 |
Protocol | String | 否 | 七层监听器协议类型,可选值:http,https。 |
LoadBalancerPort | Integer | 否 | 七层监听器的监听端口。 |
RuleSet | Array of DevicesBindInfoRule | 否 | 返回的转发规则列表。 |
DevicesBindInfoLoadBalancer
获取设备绑定信息时返回的设备被绑定所在的负载均衡信息。
被如下接口引用:DescribeDevicesBindInfo。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
LoadBalancerId | String | 否 | 负载均衡实例ID。 |
AppId | Integer | 否 | 开发商AppId。 |
ProjectId | Integer | 否 | 负载均衡所属的项目ID。 |
VpcId | String | 否 | 黑石私有网络唯一ID。 |
Vip | String | 否 | 负载均衡的IP地址。 |
TgwSetType | String | 否 | 负载均衡对应的TGW集群类别,取值为tunnel或fullnat。tunnel表示隧道集群,fullnat表示FULLNAT集群。 |
Exclusive | Integer | 否 | 是否独占TGW集群。 |
L4ListenerSet | Array of DevicesBindInfoL4Listener | 否 | 具有该绑定关系的四层监听器列表。 |
L7ListenerSet | Array of DevicesBindInfoL7Listener | 否 | 具有该绑定关系的七层监听器列表。 |
DevicesBindInfoLocation
获取设备绑定信息时返回的设备所绑定的转发路径信息。
被如下接口引用:DescribeDevicesBindInfo。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Url | String | 否 | 转发路径。 |
LocationId | String | 否 | 转发路径实例ID。 |
BackendSet | Array of DevicesBindInfoBackend | 否 | 该转发路径所绑定的主机列表。 |
DevicesBindInfoRule
获取设备绑定信息时返回的设备所绑定的转发规则信息。
被如下接口引用:DescribeDevicesBindInfo。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Domain | String | 否 | 转发域名。 |
DomainId | String | 否 | 转发域名ID。 |
LocationSet | Array of DevicesBindInfoLocation | 否 | 转发路径列表。 |
Filter
过滤器
被如下接口引用:DescribeL7ListenersEx。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Name | String | 是 | 属性名称, 若存在多个Filter时,Filter间的关系为逻辑与(AND)关系。 |
Values | Array of String | 是 | 属性值, 若同一个Filter存在多个Values,同一Filter下Values间的关系为逻辑或(OR)关系。 |
L4Backend
查询四层监听器返回的与监听器绑定关系的主机信息。
被如下接口引用:DescribeL4Backends。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
BindType | Integer | 否 | 绑定类别(0代表黑石物理机,1代表虚拟机IP)。 |
Port | Integer | 否 | 主机端口。 |
Weight | Integer | 否 | 权重。 |
Status | String | 否 | 当前绑定关系的健康检查状态(Dead代表不健康,Alive代表健康)。 |
InstanceId | String | 否 | 黑石物理机的主机ID。 |
Alias | String | 否 | 黑石物理机的别名。 |
LanIp | String | 否 | 主机IP。 |
Operates | Array of String | 否 | 黑石物理机当前可以执行的操作。 |
ProbePort | Integer | 否 | 主机探测端口。 |
L4Listener
查询四层监听器时返回的四层监听器信息。
被如下接口引用:DescribeL4Listeners。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ListenerId | String | 否 | 监听器ID。 |
ListenerName | String | 否 | 用户自定义的监听器名称。 |
Protocol | String | 否 | 负载均衡实例监听器协议类型,可选值tcp,udp。 |
LoadBalancerPort | Integer | 否 | 负载均衡监听器的监听接口,可选值1~65535。 |
Bandwidth | Integer | 否 | 用于计费模式为固定带宽计费,指定监听器最大带宽值,可选值:0-1000,单位:Mbps。 |
ListenerType | String | 否 | 监听器的类别:L4Listener(四层监听器),L7Listener(七层监听器)。 |
SessionExpire | Integer | 否 | 会话保持时间。单位:秒 |
HealthSwitch | Integer | 否 | 是否开启了检查:1(开启)、0(关闭)。 |
TimeOut | Integer | 否 | 响应超时时间,单位:秒。 |
IntervalTime | Integer | 否 | 检查间隔,单位:秒。 |
HealthNum | Integer | 否 | 负载均衡监听器健康阈值,默认值:3,表示当连续探测三次健康则表示该转发正常,可选值:2-10,单位:次。 |
UnhealthNum | Integer | 否 | 负载均衡监听器不健康阈值,默认值:3,表示当连续探测三次不健康则表示该转发不正常,可选值:2-10,单位:次。 |
CustomHealthSwitch | Integer | 否 | 是否开启自定义健康检查:1(开启)、0(关闭)。默认值0,表示关闭。(该字段在健康检查开启的情况下才生效) |
InputType | String | 否 | 自定义健康探测内容类型,可选值:text(文本)、hexadecimal(十六进制)。 |
LineSeparatorType | Integer | 否 | 探测内容类型为文本方式时,针对请求文本中换行替换方式。可选值:1(替换为LF)、2(替换为CR)、3(替换为LF+CR)。 |
HealthRequest | String | 否 | 自定义探测请求内容。 |
HealthResponse | String | 否 | 自定义探测返回内容。 |
ToaFlag | Integer | 否 | 是否开启toa:1(开启)、0(关闭)。 |
Status | Integer | 否 | 监听器当前状态(0代表创建中,1代表正常运行,2代表创建失败,3代表删除中,4代表删除失败)。 |
AddTimestamp | Timestamp | 否 | 创建时间戳。 |
BalanceMode | String | 否 | 转发后端服务器调度类型。 |
L4ListenerInfo
查询绑定了某主机的四层监听器时返回的四层监听器信息。
被如下接口引用:DescribeL4ListenerInfo。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ListenerId | String | 否 | 监听器ID。 |
ListenerName | String | 否 | 用户自定义的监听器名称。 |
Protocol | String | 否 | 负载均衡实例监听器协议类型,可选值tcp,udp。 |
LoadBalancerPort | Integer | 否 | 负载均衡监听器的监听接口,可选值1~65535。 |
Bandwidth | Integer | 否 | 用于计费模式为固定带宽计费,指定监听器最大带宽值,可选值:0-1000,单位:Mbps。 |
ListenerType | String | 否 | 监听器的类别:L4Listener(四层监听器),L7Listener(七层监听器)。 |
SessionExpire | Integer | 否 | 会话保持时间。单位:秒 |
HealthSwitch | Integer | 否 | 是否开启了检查:1(开启)、0(关闭)。 |
TimeOut | Integer | 否 | 响应超时时间,单位:秒。 |
IntervalTime | Integer | 否 | 检查间隔,单位:秒。 |
HealthNum | Integer | 否 | 负载均衡监听器健康阈值,默认值:3,表示当连续探测三次健康则表示该转发正常,可选值:2-10,单位:次。 |
UnhealthNum | Integer | 否 | 负载均衡监听器不健康阈值,默认值:3,表示当连续探测三次不健康则表示该转发不正常,可选值:2-10,单位:次。 |
Status | Integer | 否 | 监听器当前状态(0代表创建中,1代表正常运行,2代表创建失败,3代表删除中,4代表删除失败)。 |
AddTimestamp | Timestamp | 否 | 创建时间戳。 |
CustomHealthSwitch | Integer | 否 | 是否开启自定义健康检查:1(开启)、0(关闭)。默认值0,表示关闭。(该字段在健康检查开启的情况下才生效) |
InputType | String | 否 | 自定义健康探测内容类型,可选值:text(文本)、hexadecimal(十六进制)。 |
LineSeparatorType | Integer | 否 | 探测内容类型为文本方式时,针对请求文本中换行替换方式。可选值:1(替换为LF)、2(替换为CR)、3(替换为LF+CR)。 |
HealthRequest | String | 否 | 自定义探测请求内容。 |
HealthResponse | String | 否 | 自定义探测返回内容。 |
ToaFlag | Integer | 否 | 是否开启toa:1(开启)、0(关闭)。 |
BalanceMode | String | 否 | 转发后端服务器调度类型。 |
L7Backend
获取七层转发路径绑定的主机列表时返回的主机信息。
被如下接口引用:DescribeL7Backends。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
BindType | Integer | 否 | 绑定类别(0代表黑石物理机,1代表虚拟机IP)。 |
Port | Integer | 否 | 主机端口。 |
Weight | Integer | 否 | 权重。 |
Status | String | 否 | 当前绑定关系的健康检查状态(Dead代表不健康,Alive代表健康)。 |
InstanceId | String | 否 | 黑石物理机的主机ID。 |
Alias | String | 否 | 黑石物理机的别名。 |
LanIp | String | 否 | 主机IP。 |
MgtIp | String | 否 | 黑石物理机的管理IP。 |
Operates | Array of String | 否 | 黑石物理机当前可以执行的操作。 |
L7ExListener
监听器信息。
被如下接口引用:DescribeL7ListenersEx。
名称 | 类型 | 描述 |
---|---|---|
ListenerId | String | 绑定的监听器唯一ID。 |
ListenerName | String | 监听器名称。 |
Protocol | String | 七层监听器协议类型,可选值:http,https。 |
LoadBalancerPort | Integer | 监听器的监听端口。 |
Bandwidth | Integer | 当前带宽。 |
MaxBandwidth | Integer | 带宽上限。 |
ListenerType | String | 监听器类型。 |
SslMode | Integer | 认证方式:0(不认证,用于http),1(单向认证,用于https),2(双向认证,用于https)。 |
CertId | String | 服务端证书ID。 |
CertCaId | String | 客户端证书ID。 |
AddTimestamp | Timestamp | 添加时间。 |
LoadBalancerId | String | 负载均衡名ID。 |
VpcName | String | 私有网络名称。 |
VpcCidrBlock | String | 私有网络Cidr。 |
LoadBalancerVips | Array of String | 负载均衡的VIP。 |
LoadBalancerName | String | 负载均衡名称。 |
LoadBalancerVipv6s | Array of String | 负载均衡IPV6的VIP。 |
IpProtocolType | String | 支持的IP协议类型。ipv4或者是ipv6。 |
BindTrafficMirror | Boolean | 是否绑定在入参指定的流量镜像中。 |
L7Listener
获取黑石负载均衡七层监听器时返回的七层监听器信息。
被如下接口引用:DescribeL7Listeners。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ListenerId | String | 否 | 七层监听器实例ID。 |
ListenerName | String | 否 | 七层监听器名称。 |
Protocol | String | 否 | 七层监听器协议类型,可选值:http,https。 |
LoadBalancerPort | Integer | 否 | 七层监听器的监听端口。 |
Bandwidth | Integer | 否 | 计费模式为按固定带宽方式时监听器的限速值,单位:Mbps。 |
ListenerType | String | 否 | 监听器的类别:L4Listener(四层监听器),L7Listener(七层监听器)。 |
SslMode | Integer | 否 | 七层监听器的认证方式:0(不认证,用于http),1(单向认证,用于https),2(双向认证,用于https)。 |
CertId | String | 否 | 七层监听器关联的服务端证书ID。 |
CertCaId | String | 否 | 七层监听器关联的客户端证书ID。 |
Status | Integer | 否 | 监听器当前状态(0代表创建中,1代表正常运行,2代表创建失败,3代表删除中,4代表删除失败)。 |
AddTimestamp | Timestamp | 否 | 创建时间戳。 |
ForwardProtocol | Integer | 否 | https转发类型。0:https。1:spdy。2:http2。3:spdy+http2。 |
L7ListenerInfo
查询绑定了某主机的七层监听器时返回的七层监听器信息。
被如下接口引用:DescribeL7ListenerInfo。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ListenerId | String | 否 | 七层监听器实例ID。 |
ListenerName | String | 否 | 七层监听器名称。 |
Protocol | String | 否 | 七层监听器协议类型,可选值:http,https。 |
LoadBalancerPort | Integer | 否 | 七层监听器的监听端口。 |
Bandwidth | Integer | 否 | 计费模式为按固定带宽方式时监听器的限速值,单位:Mbps。 |
ListenerType | String | 否 | 监听器的类别:L4Listener(四层监听器),L7Listener(七层监听器)。 |
SslMode | Integer | 否 | 七层监听器的认证方式:0(不认证,用于http),1(单向认证,用于https),2(双向认证,用于https)。 |
CertId | String | 否 | 七层监听器关联的服务端证书ID。 |
CertCaId | String | 否 | 七层监听器关联的客户端证书ID。 |
Status | Integer | 否 | 当前绑定关系的健康检查状态(Dead代表不健康,Alive代表健康)。 |
AddTimestamp | Timestamp | 否 | 创建时间戳。 |
RuleSet | Array of L7ListenerInfoRule | 否 | 返回的转发规则列表。 |
ForwardProtocol | Integer | 否 | https转发类型。0:https。1:spdy。2:http2。3:spdy+http2。 |
L7ListenerInfoBackend
查询绑定了某主机七层监听器时返回的与转发路径所绑定的主机信息。
被如下接口引用:DescribeL7ListenerInfo。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
BindType | Integer | 否 | 绑定类别(0代表黑石物理机,1代表虚拟机IP)。 |
Port | Integer | 否 | 主机端口。 |
Weight | Integer | 否 | 权重。 |
Status | String | 否 | 当前绑定关系的健康检查状态(Dead代表不健康,Alive代表健康)。 |
InstanceId | String | 否 | 黑石物理机的主机ID。 |
Alias | String | 否 | 黑石物理机的别名。 |
LanIp | String | 否 | 主机IP。 |
L7ListenerInfoLocation
查询绑定了某主机的七层监听器时返回的转发路径。
被如下接口引用:DescribeL7ListenerInfo。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Url | String | 否 | 转发路径。 |
LocationId | String | 否 | 转发路径实例ID。 |
SessionExpire | Integer | 否 | 会话保持时间。 |
HealthSwitch | Integer | 否 | 是否开启健康检查。 |
HttpCheckPath | String | 否 | 健康检查检查路径。 |
HttpCheckDomain | String | 否 | 健康检查检查域名。 |
IntervalTime | Integer | 否 | 健康检查检查间隔时间。 |
HealthNum | Integer | 否 | 健康检查健康阈值。 |
UnhealthNum | Integer | 否 | 健康检查不健康阈值。 |
HttpCodes | Array of Integer | 否 | 健康检查中认为健康的HTTP返回码的组合。可选值为1~5的集合,1表示HTTP返回码为1xx认为健康。2表示HTTP返回码为2xx认为健康。3表示HTTP返回码为3xx认为健康。4表示HTTP返回码为4xx认为健康。5表示HTTP返回码为5xx认为健康。 |
BalanceMode | String | 否 | 均衡方式。 |
Status | Integer | 否 | 当前绑定关系的健康检查状态(Dead代表不健康,Alive代表健康)。 |
AddTimestamp | Timestamp | 否 | 创建时间戳。 |
BackendSet | Array of L7ListenerInfoBackend | 否 | 该转发路径所绑定的主机列表。 |
L7ListenerInfoRule
查询绑定了某主机的七层监听器时返回的转发规则。
被如下接口引用:DescribeL7ListenerInfo。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Domain | String | 否 | 转发域名。 |
DomainId | String | 否 | 转发域名实例ID。 |
Status | Integer | 否 | 当前绑定关系的健康检查状态(Dead代表不健康,Alive代表健康)。 |
AddTimestamp | Timestamp | 否 | 创建时间戳。 |
LocationSet | Array of L7ListenerInfoLocation | 否 | 该转发域名下面的转发路径列表。 |
L7Rule
获取七层监听器转发规则时返回的转发规则。
被如下接口引用:DescribeL7Rules。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Domain | String | 否 | 转发域名。 |
DomainId | String | 否 | 转发域名实例ID。 |
Status | Integer | 否 | 转发路径当前状态(0代表创建中,1代表正常运行,2代表创建失败,3代表删除中,4代表删除失败)。 |
AddTimestamp | Timestamp | 否 | 创建时间戳。 |
LocationSet | Array of L7RulesLocation | 否 | 该转发域名下面的转发路径列表。 |
L7RulesLocation
获取七层转发规则时返回的转发域名下面的转发路径。
被如下接口引用:DescribeL7Rules。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Url | String | 否 | 转发路径。 |
LocationId | String | 否 | 转发路径实例ID。 |
SessionExpire | Integer | 否 | 会话保持时间。 |
HealthSwitch | Integer | 否 | 是否开启健康检查。 |
HttpCheckPath | String | 否 | 健康检查检查路径。 |
HttpCheckDomain | String | 否 | 健康检查检查域名。 |
IntervalTime | Integer | 否 | 健康检查检查间隔时间。 |
HealthNum | Integer | 否 | 健康检查健康阈值。 |
UnhealthNum | Integer | 否 | 健康检查不健康阈值。 |
HttpCodes | Array of Integer | 否 | 健康检查中认为健康的HTTP返回码的组合。可选值为1~5的集合,1表示HTTP返回码为1xx认为健康。2表示HTTP返回码为2xx认为健康。3表示HTTP返回码为3xx认为健康。4表示HTTP返回码为4xx认为健康。5表示HTTP返回码为5xx认为健康。 |
BalanceMode | String | 否 | 均衡方式。 |
Status | Integer | 否 | 转发路径当前状态(0代表创建中,1代表正常运行,2代表创建失败,3代表删除中,4代表删除失败)。 |
AddTimestamp | Timestamp | 否 | 创建时间戳。 |
LoadBalancer
获取负载均衡实例列表时返回的负载均衡信息。
被如下接口引用:DescribeLoadBalancers。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
LoadBalancerId | String | 否 | 负载均衡器ID |
ProjectId | Integer | 否 | 项目ID,通过v2/DescribeProject 接口获得 |
LoadBalancerName | String | 否 | 负载均衡器名称 |
LoadBalancerType | String | 否 | 负载均衡的类型 : open表示公网负载均衡类型,internal表示内网负载均衡类型 |
Exclusive | Integer | 否 | 是否筛选独占集群,0表示非独占集群,1表示四层独占集群,2表示七层独占集群,3表示四层和七层独占集群,4表示共享容灾 |
TgwSetType | String | 否 | 该负载均衡对应的tgw集群(fullnat,tunnel,dnat) |
Domain | String | 否 | 负载均衡域名。规则:1-60个小写英文字母、数字、点号“.”或连接线“-”。内网类型的负载均衡不能配置该字段 |
VpcId | String | 否 | 该负载均衡对应的所在的VpcId |
SubnetId | String | 否 | 该负载均衡对应的所在的SubnetId |
Status | Integer | 否 | 无 |
PayMode | String | 否 | 无 |
LatestPayMode | String | 否 | 无 |
CreateTime | Timestamp | 否 | 无 |
StatusTime | Timestamp | 否 | 无 |
VpcName | String | 否 | 私有网络名称。 |
VpcCidrBlock | String | 否 | 私有网络Cidr。 |
LoadBalancerVips | Array of String | 否 | 负载均衡的IPV4的VIP。 |
SupportListenerTypes | Array of String | 否 | 无 |
Bandwidth | Integer | 否 | 无 |
ConfId | String | 否 | 负载均衡个性化配置ID |
ConfName | String | 否 | 无 |
LoadBalancerVipv6s | Array of String | 否 | 负载均衡的IPV6的VIP。 |
IpProtocolType | String | 否 | 负载均衡IP协议类型。ipv4或者ipv6。 |
BzPayMode | String | 否 | 保障型网关计费形式 |
BzL4Metrics | String | 否 | 保障型网关四层计费指标 |
BzL7Metrics | String | 否 | 保障型网关七层计费指标 |
IntVpcId | Integer | 否 | 该负载均衡对应的所在的整形类型的VpcId |
CurVips | Array of String | 否 | 负载均衡的IPV6或者IPV4的VIP。 注意:此字段可能返回 null,表示取不到有效值。 |
LoadBalancerPortInfoListener
获取黑石负载均衡端口相关信息时返回的监听器信息(四层和七层)。
被如下接口引用:DescribeLoadBalancerPortInfo。
名称 | 类型 | 描述 |
---|---|---|
ListenerId | String | 负载均衡监听器ID。 |
ListenerName | String | 监听器名称。 |
Protocol | String | 监听器协议类型,可选值:http,https,tcp,udp。 |
LoadBalancerPort | Integer | 监听器的监听端口。 |
Bandwidth | Integer | 计费模式为按固定带宽方式时监听器的限速值,单位:Mbps。 |
Status | Integer | 监听器当前状态(0代表创建中,1代表正常运行,2代表创建失败,3代表删除中,4代表删除失败)。 |
Port | Integer | 与监听器绑定的主机端口。 |
ModifyL7LocationRule
修改黑石负载均衡七层转发路径时待修改的七层转发规则信息。
被如下接口引用:ModifyL7Locations。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
DomainId | String | 是 | 转发域名实例ID,可通过接口DescribeL7Rules查询。 |
LocationId | String | 是 | 转发路径实例ID,可通过接口DescribeL7Rules查询。 |
Url | String | 否 | 转发路径。 |
SessionExpire | Integer | 否 | 会话保持时间,单位:秒。可选值:30~3600。默认值0,表示不开启会话保持。 |
HealthSwitch | Integer | 否 | 健康检查开关:1(开启)、0(关闭)。默认值0,表示关闭。 |
IntervalTime | Integer | 否 | 健康检查检查间隔时间,默认值:5,可选值:5-300,单位:秒。 |
HealthNum | Integer | 否 | 健康检查健康阈值,默认值:3,表示当连续探测三次健康则表示该转发正常,可选值:2-10,单位:次。 |
UnhealthNum | Integer | 否 | 健康检查不健康阈值,默认值:5,表示当连续探测五次不健康则表示该转发不正常,可选值:2-10,单位:次。 |
HttpCodes | Array of Integer | 否 | 健康检查中认为健康的HTTP返回码的组合。可选值为1~5的集合,1表示HTTP返回码为1xx认为健康。2表示HTTP返回码为2xx认为健康。3表示HTTP返回码为3xx认为健康。4表示HTTP返回码为4xx认为健康。5表示HTTP返回码为5xx认为健康。 |
HttpCheckPath | String | 否 | 健康检查检查路径。 |
HttpCheckDomain | String | 否 | 健康检查检查域名。如果规则的域名使用通配符或正则表达式,则健康检查检查域名可自定义,否则必须跟健康检查检查域名一样。不填表示不修改。 |
BalanceMode | String | 否 | 均衡方式:ip_hash、wrr。默认值wrr。 |
Domain | String | 否 | 转发域名。 |
ModifyLoadBalancerChargeModeListener
修改负载均衡计费方式的监听器信息。
被如下接口引用:ModifyLoadBalancerChargeMode。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
ListenerId | String | 是 | 监听器ID。 |
Protocol | String | 是 | 协议类型。 |
Bandwidth | Integer | 是 | 带宽。 |
TrafficMirror
获取流量镜像实例的列表信息时返回的流量镜像信息。
被如下接口引用:DescribeTrafficMirrors。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
TrafficMirrorId | String | 否 | 流量镜像ID。 |
Alias | String | 否 | 流量镜像名称。 |
VpcId | String | 否 | 流量镜像所在的私有网络ID。 |
LoadBalancerType | String | 否 | 接收机负载均衡方式。wrr,ip_hash,wlc。 |
HealthSwitch | Integer | 否 | 是否开始对接收机的健康检查。0:关闭,非0:开启。 |
HealthNum | Integer | 否 | 健康阈值。 |
UnhealthNum | Integer | 否 | 不健康阈值。 |
IntervalTime | Integer | 否 | 检查间隔。 |
HttpCheckDomain | String | 否 | 检查域名。 |
HttpCheckPath | String | 否 | 检查目录。 |
HttpCodes | Array of Integer | 否 | 健康检查返回码。 1:1xx,2:2xx,3:3xx,4:4xx,5:5xx。 |
CreateTime | Timestamp | 否 | 创建时间。 |
VpcCidrBlock | String | 否 | 流量镜像所在私有网络的Cidr。 |
VpcName | String | 否 | 流量镜像所在私有网络的名称。 |
TrafficMirrorListener
获取流量镜像的监听器列表信息时返回的与流量镜像绑定的监听器信息。
被如下接口引用:DescribeTrafficMirrorListeners。
名称 | 类型 | 描述 |
---|---|---|
ListenerId | String | 监听器ID。 |
ListenerName | String | 监听器名称。 |
Protocol | String | 七层监听器协议类型,可选值:http,https。 |
LoadBalancerPort | Integer | 监听器的监听端口。 |
Bandwidth | Integer | 当前带宽。 |
MaxBandwidth | Integer | 带宽上限。 |
ListenerType | String | 监听器类型。 |
SslMode | Integer | 认证方式:0(不认证,用于http),1(单向认证,用于https),2(双向认证,用于https)。 |
CertId | String | 服务端证书ID。 |
CertCaId | String | 客户端证书ID。 |
AddTimestamp | Timestamp | 添加时间。 |
LoadBalancerId | String | 负载均衡ID。 |
VpcName | String | 私有网络名称。 |
VpcCidrBlock | String | 私有网络Cidr。 |
LoadBalancerVips | Array of String | 负载均衡的VIP。 |
LoadBalancerName | String | 负载均衡名称。 |
LoadBalancerVipv6s | Array of String | 负载均衡的IPV6的VIP。 |
IpProtocolType | String | 支持的IP协议类型。ipv4或者是ipv6。 |
TrafficMirrorPortStatus
流量镜像健康检查返回的接收机的端口及状态信息。
被如下接口引用:DescribeTrafficMirrorReceiverHealthStatus。
名称 | 类型 | 描述 |
---|---|---|
Port | Integer | 接收机端口。 |
Status | String | 状态。 |
TrafficMirrorReceiver
获取与流量镜像绑定的接收机信息时返回的接收机信息。
被如下接口引用:DescribeTrafficMirrorReceivers。
名称 | 类型 | 描述 |
---|---|---|
InstanceId | String | 接收机实例ID。 |
Port | Integer | 接收机接收端口。 |
Weight | Integer | 接收机权重。 |
TrafficMirrorId | String | 流量镜像ID。 |
Alias | String | 接收机别名。 |
LanIp | String | 接收机内网IP地址。 |
SubnetId | String | 接收机所在的子网的ID。 |
SubnetName | String | 接收机所在的子网的名称。 |
SubnetCidrBlock | String | 接收机所在的子网的Cidr。 |
VpcId | String | 接收机所在的私有网络的ID。 |
VpcName | String | 接收机所在的私有网络的名称。 |
VpcCidrBlock | String | 接收机所在的私有网络的Cidr。 |
HealthStatus | String | 接收机的健康状态。 |
Operates | Array of String | 接收机的可以执行的操作集合。 |
TrafficMirrorReciversStatus
流量镜像健康检查返回的接收机状态信息。
被如下接口引用:DescribeTrafficMirrorReceiverHealthStatus。
名称 | 类型 | 描述 |
---|---|---|
LanIp | String | 内网IP。 |
ReceiversPortStatusSet | Array of TrafficMirrorPortStatus | 端口及对应的状态。 |
UnbindL4Backend
待与四层监听器解绑的物理机主机、虚拟机或半托管主机信息。
被如下接口引用:UnbindL4Backends。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Port | Integer | 否 | 待解绑的主机端口,可选值1~65535。 |
InstanceId | String | 否 | 黑石物理机主机ID、虚拟机IP或者是半托管主机ID。 |
UnbindL7Backend
待与七层监听器转发规则解绑的物理机主机、虚拟机或半托管主机信息。
被如下接口引用:UnbindL7Backends。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Port | Integer | 否 | 待解绑的主机端口,可选值1~65535。 |
InstanceId | String | 否 | 黑石物理机主机ID、虚拟机IP或者是半托管主机ID。 |
UnbindTrafficMirrorReceiver
待与流量镜像解绑的接收机信息。
被如下接口引用:UnbindTrafficMirrorReceivers。
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
Port | Integer | 是 | 待解绑的主机端口,可选值1~65535。 |
InstanceId | String | 是 | 待解绑的主机实例ID。 |