Skip to content

Latest commit

 

History

History
376 lines (210 loc) · 17.4 KB

File metadata and controls

376 lines (210 loc) · 17.4 KB

API Reference

Packages

networking.cloud.tencent.com/v1alpha1

Resource Types

AutoCreateConfig

AutoCreateConfig 定义自动创建 CLB 的配置

Appears in:

Field Description Default Validation
enabled boolean 是否启用自动创建
maxLoadBalancers integer 自动创建的最大负载均衡器数量
parameters CreateLBParameters 自动创建参数

CLBBindingSpec

CLBBindingSpec defines the desired state of CLBPodBinding.

Appears in:

Field Description Default Validation
disabled boolean 网络隔离
ports PortEntry array 需要绑定的端口配置列表

CLBBindingState

Underlying type: string

Appears in:

Field Description
Pending
Bound
NoBackend
WaitBackend
NodeTypeNotSupported
Disabled
Failed
PortPoolNotFound
NoPortAvailable
Deleting
PortPoolNotAllocatable
Allocated

CLBBindingStatus

CLBBindingStatus defines the observed state of CLBPodBinding.

Appears in:

Field Description Default Validation
state CLBBindingState 绑定状态 Pending
message string 状态信息
portBindings PortBindingStatus array 端口绑定详情

CLBNodeBinding

CLBNodeBinding is the Schema for the clbnodebindings API.

Field Description Default Validation
apiVersion string networking.cloud.tencent.com/v1alpha1
kind string CLBNodeBinding
kind string Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
apiVersion string APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec CLBBindingSpec
status CLBBindingStatus

CLBPodBinding

CLBPodBinding is the Schema for the clbpodbindings API.

Field Description Default Validation
apiVersion string networking.cloud.tencent.com/v1alpha1
kind string CLBPodBinding
kind string Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
apiVersion string APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec CLBBindingSpec
status CLBBindingStatus

CLBPortPool

CLBPortPool is the Schema for the clbportpools API.

Field Description Default Validation
apiVersion string networking.cloud.tencent.com/v1alpha1
kind string CLBPortPool
kind string Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
apiVersion string APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec CLBPortPoolSpec
status CLBPortPoolStatus

CLBPortPoolSpec

CLBPortPoolSpec defines the desired state of CLBPortPool.

Appears in:

Field Description Default Validation
startPort integer 端口池的起始端口号
endPort integer 端口池的结束端口号
listenerQuota integer 监听器数量配额。仅用在单独调整了指定 CLB 实例监听器数量配额的场景(TOTAL_LISTENER_QUOTA),
控制器默认会获取账号维度的监听器数量配额作为端口分配的依据,如果 listenerQuota 不为空,
将以它的值作为该端口池中所有 CLB 监听器数量配额覆盖账号维度的监听器数量配额。

注意:如果指定了 listenerQuota,不支持启用 CLB 自动创建,且需自行保证该端口池中所有 CLB
实例的监听器数量配额均等于 listenerQuota 的值。
segmentLength integer 端口段的长度
region string 地域代码,如ap-chengdu
lbPolicy string CLB 分配策略,单个端口池中有多个可分配 CLB ,分配端口时 CLB 的挑选策略。
可选值:Uniform(均匀分配)、InOrder(顺序分配)、Random(随机分配)。默认值为 Random。

若希望减小 DDoS 攻击的影响,建议使用 Uniform 策略,避免业务使用的 IP 过于集中;若希望提高
CLB 的利用率,建议使用 InOrder 策略。
Enum: [Uniform InOrder Random]
lbBlacklist string array CLB 黑名单,负载均衡实例 ID 的数组,用于禁止某些 CLB 实例被分配端口,可动态追加和移除。
如果发现某个 CLB 被 DDoS 攻击或其他原因导致不可用,可将该 CLB 的实例 ID 加入到黑名单中,
避免后续端口分配使用该 CLB。
exsistedLoadBalancerIDs string array 已有负载均衡器实例 ID 列表,可动态追加。
该列表的负载均衡器将会被端口池用于分配端口映射。
autoCreate AutoCreateConfig 自动创建的配置,如果启用,则当端口池中负载均衡器可用监听器数量不足时会自动创建新的负载
均衡器来补充可分配监听器数量。

CLBPortPoolState

Underlying type: string

Appears in:

Field Description
Pending
Active
Scaling
Deleting

CLBPortPoolStatus

CLBPortPoolStatus defines the observed state of CLBPortPool.

Appears in:

Field Description Default Validation
state CLBPortPoolState 状态: Pending/Active/Scaling Pending
message string 状态信息
quota integer 监听器数量的 Quota
loadbalancerStatuses LoadBalancerStatus array 负载均衡器状态列表

CreateLBParameters

CreateLBParameters 定义创建负载均衡器的参数

Appears in:

Field Description Default Validation
vipIsp string 仅适用于公网负载均衡。目前仅广州、上海、南京、济南、杭州、福州、北京、石家庄、武汉、长沙、成都、重庆地域支持静态单线 IP 线路类型,如需体验,请联系商务经理申请。申请通过后,即可选择中国移动(CMCC)、中国联通(CUCC)或中国电信(CTCC)的运营商类型,网络计费模式只能使用按带宽包计费(BANDWIDTH_PACKAGE)。 如果不指定本参数,则默认使用BGP。可通过 DescribeResources 接口查询一个地域所支持的Isp。 Enum: [CMCC CUCC CTCC BGP]
bandwidthPackageId string 带宽包ID,指定此参数时,网络计费方式(InternetAccessible.InternetChargeType)只支持按带宽包计费(BANDWIDTH_PACKAGE),带宽包的属性即为其结算方式。非上移用户购买的 IPv6 负载均衡实例,且运营商类型非 BGP 时 ,不支持指定具体带宽包id。
addressIPVersion string 仅适用于公网负载均衡。IP版本,可取值:IPV4、IPV6、IPv6FullChain,不区分大小写,默认值 IPV4。说明:取值为IPV6表示为IPV6 NAT64版本;取值为IPv6FullChain,表示为IPv6版本。 Enum: [IPV4 IPV6 IPv6FullChain]
loadBalancerPassToTarget boolean Target是否放通来自CLB的流量。开启放通(true):只验证CLB上的安全组;不开启放通(false):需同时验证CLB和后端实例上的安全组。默认值为 true。
dynamicVip boolean 是否创建域名化负载均衡。
vpcId string 负载均衡后端目标设备所属的网络 ID,如vpc-12345678,可以通过 DescribeVpcs 接口获取。 不填此参数则默认为当前集群所在 VPC。创建内网负载均衡实例时,此参数必填。
vip string 指定VIP申请负载均衡。此参数选填,不填写此参数时自动分配VIP。IPv4和IPv6类型支持此参数,IPv6 NAT64类型不支持。
注意:当指定VIP创建内网实例、或公网IPv6 BGP实例时,若VIP不属于指定VPC子网的网段内时,会创建失败;若VIP已被占用,也会创建失败。
tags TagInfo array 购买负载均衡的同时,给负载均衡打上标签,最大支持20个标签键值对。
projectId integer 负载均衡实例所属的项目 ID,可以通过 DescribeProject 接口获取。不填此参数则视为默认项目。
loadBalancerName string 负载均衡实例的名称。规则:1-60 个英文、汉字、数字、连接线“-”或下划线“_”。 注意:如果名称与系统中已有负载均衡实例的名称相同,则系统将会自动生成此次创建的负载均衡实例的名称。
loadBalancerType string 负载均衡实例的网络类型:OPEN:公网属性, INTERNAL:内网属性。默认使用 OPEN(公网负载均衡)。 Enum: [OPEN INTERNAL]
masterZoneId string 仅适用于公网且IP版本为IPv4的负载均衡。设置跨可用区容灾时的主可用区ID,例如 100001 或 ap-guangzhou-1
注:主可用区是需要承载流量的可用区,备可用区默认不承载流量,主可用区不可用时才使用备可用区。目前仅广州、上海、南京、北京、成都、深圳金融、中国香港、首尔、法兰克福、新加坡地域的 IPv4 版本的 CLB 支持主备可用区。可通过 DescribeResources 接口查询一个地域的主可用区的列表。【如果您需要体验该功能,请通过 工单申请】
zoneId string 仅适用于公网且IP版本为IPv4的负载均衡。可用区ID,指定可用区以创建负载均衡实例。
subnetId string 在私有网络内购买内网负载均衡实例的情况下,必须指定子网 ID,内网负载均衡实例的 VIP 将从这个子网中产生。创建内网负载均衡实例时,此参数必填,创建公网IPv4负载均衡实例时,不支持指定该参数。
slaType string 性能容量型规格。
若需要创建性能容量型实例,则此参数必填,取值范围:
clb.c2.medium:标准型规格
clb.c3.small:高阶型1规格
clb.c3.medium:高阶型2规格
clb.c4.small:超强型1规格
clb.c4.medium:超强型2规格
clb.c4.large:超强型3规格
clb.c4.xlarge:超强型4规格
若需要创建共享型实例,则无需填写此参数。
Enum: [clb.c2.medium clb.c3.small clb.c3.medium clb.c4.small clb.c4.medium clb.c4.large clb.c4.xlarge]
lbChargeType string 负载均衡实例计费类型,取值:POSTPAID_BY_HOUR,PREPAID,默认是POSTPAID_BY_HOUR。 Enum: [POSTPAID_BY_HOUR PREPAID]
internetAccessible InternetAccessible 仅适用于公网负载均衡。负载均衡的网络计费模式。

InternetAccessible

InternetAccessible 定义网络计费相关参数

Appears in:

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

LoadBalancerState

Underlying type: string

Appears in:

Field Description
Running
NotFound

LoadBalancerStatus

LoadBalancerStatus 定义负载均衡器状态

Appears in:

Field Description Default Validation
autoCreated boolean 是否自动创建
state LoadBalancerState CLB 状态(Running/NotFound)
loadbalancerID string CLB 实例 ID
loadbalancerName string CLB 实例名称
ips string array CLB 实例的 IP 地址
hostname string CLB 实例的域名 (域名化 CLB)
allocated integer 已分配的监听器数量

PortBindingStatus

PortBindingStatus 描述单个端口的实际绑定情况

Appears in:

Field Description Default Validation
port integer 应用端口
protocol string 协议类型
certId string 服务端证书 ID(仅在 TCP_SSL 和 QUIC 协议下有效)
pool string 使用的端口池
region string 地域信息
loadbalancerId string 负载均衡器ID
loadbalancerPort integer 负载均衡器端口
loadbalancerEndPort integer 负载均衡器端口段结束端口(当使用端口段时)
listenerId string 监听器ID

PortEntry

PortEntry 定义单个端口的绑定配置

Appears in:

Field Description Default Validation
port integer 应用监听的端口号
protocol string 端口使用的协议 Enum: [TCP UDP TCPUDP TCP_SSL QUIC]
pools string array 使用的端口池列表
useSamePortAcrossPools boolean 是否跨端口池分配相同端口号
certSecretName string 包含服务端证书的 ID 的 Secret 名称。仅对 TCP_SSL 和 QUIC 协议有效。

TagInfo

TagInfo 定义标签结构

Appears in:

Field Description Default Validation
tagKey string 标签的键
tagValue string 标签的值