Skip to content

Latest commit

 

History

History
582 lines (303 loc) · 23.2 KB

api.md

File metadata and controls

582 lines (303 loc) · 23.2 KB

API Reference

Packages

networking.cloud.tencent.com/v1alpha1

Resource Types

AllocatableCLBInfo

Appears in:

Field Description Default Validation
lbId string CLB 实例的 ID。
currentPort integer CLB 当前已被分配的端口。
autoCreate boolean 是否是自动创建的 CLB。如果是，删除 DedicatedCLBService 时，CLB 也会被清理。

AllocatedCLBInfo

Appears in:

Field Description Default Validation
lbId string CLB 实例的 ID。
autoCreate boolean 是否是自动创建的 CLB。如果是，删除 DedicatedCLBService 时，CLB 也会被清理。

AutoCreateConfig

AutoCreateConfig 定义自动创建CLB的配置

Appears in:

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

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 CLBNodeBindingSpec
status CLBNodeBindingStatus

CLBNodeBindingSpec

CLBNodeBindingSpec defines the desired state of CLBNodeBinding.

Appears in:

Field Description Default Validation
foo string Foo is an example field of CLBNodeBinding. Edit clbnodebinding_types.go to remove/update

CLBNodeBindingStatus

CLBNodeBindingStatus defines the observed state of CLBNodeBinding.

Appears in:

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 CLBPodBindingSpec
status CLBPodBindingStatus

CLBPodBindingSpec

CLBPodBindingSpec defines the desired state of CLBPodBinding.

Appears in:

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

CLBPodBindingState

Underlying type: string

Appears in:

Field Description
Pending
Bound
WaitForPod
Disabled
Failed
Deleting

CLBPodBindingStatus

CLBPodBindingStatus defines the observed state of CLBPodBinding.

Appears in:

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

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 端口池的结束端口号
segmentLength integer 端口段的长度
region string 地域代码，如ap-chengdu
exsistedLoadBalancerIDs string array 已有负载均衡器ID列表
autoCreate AutoCreateConfig 自动创建配置

CLBPortPoolState

Underlying type: string

Appears in:

Field Description
Pending
Active
Scaling

CLBPortPoolStatus

CLBPortPoolStatus defines the observed state of CLBPortPool.

Appears in:

Field Description Default Validation
state CLBPortPoolState 状态: Pending/Active/Scaling
message string 状态信息
loadbalancerStatuses LoadBalancerStatus array 负载均衡器状态列表

CreateLBParameters

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

Appears in:

Field Description Default Validation
vipIsp string 仅适用于公网负载均衡。目前仅广州、上海、南京、济南、杭州、福州、北京、石家庄、武汉、长沙、成都、重庆地域支持静态单线 IP 线路类型，如需体验，请联系商务经理申请。申请通过后，即可选择中国移动（CMCC）、中国联通（CUCC）或中国电信（CTCC）的运营商类型，网络计费模式只能使用按带宽包计费(BANDWIDTH_PACKAGE)。 如果不指定本参数，则默认使用BGP。可通过 DescribeResources 接口查询一个地域所支持的Isp。
bandwidthPackageId string 带宽包ID，指定此参数时，网络计费方式（InternetAccessible.InternetChargeType）只支持按带宽包计费（BANDWIDTH_PACKAGE），带宽包的属性即为其结算方式。非上移用户购买的 IPv6 负载均衡实例，且运营商类型非 BGP 时 ，不支持指定具体带宽包id。
addressIPVersion string 仅适用于公网负载均衡。IP版本，可取值：IPV4、IPV6、IPv6FullChain，不区分大小写，默认值 IPV4。说明：取值为IPV6表示为IPV6 NAT64版本；取值为IPv6FullChain，表示为IPv6版本。
loadBalancerPassToTarget boolean Target是否放通来自CLB的流量。开启放通（true）：只验证CLB上的安全组；不开启放通（false）：需同时验证CLB和后端实例上的安全组。默认值为 true。
dynamicVip boolean 是否创建域名化负载均衡。
vpcId string 负载均衡后端目标设备所属的网络 ID，如vpc-12345678，可以通过 DescribeVpcs 接口获取。 不填此参数则默认为当前集群所在 VPC。创建内网负载均衡实例时，此参数必填。
vip string 仅适用于公网负载均衡。目前仅广州、上海、南京、济南、杭州、福州、北京、石家庄、武汉、长沙、成都、重庆地域支持静态单线 IP 线路类型，如需体验，请联系商务经理申请。申请通过后，即可选择中国移动（CMCC）、中国联通（CUCC）或中国电信（CTCC）的运营商类型，网络计费模式只能使用按带宽包计费(BANDWIDTH_PACKAGE)。 如果不指定本参数，则默认使用BGP。可通过 DescribeResources 接口查询一个地域所支持的Isp。
tags TagInfo array 购买负载均衡的同时，给负载均衡打上标签，最大支持20个标签键值对。
projectId integer 负载均衡实例所属的项目 ID，可以通过 DescribeProject 接口获取。不填此参数则视为默认项目。
loadBalancerName string 负载均衡实例的名称。规则：1-60 个英文、汉字、数字、连接线“-”或下划线“_”。 注意：如果名称与系统中已有负载均衡实例的名称相同，则系统将会自动生成此次创建的负载均衡实例的名称。
loadBalancerType string 负载均衡实例的网络类型：OPEN：公网属性， INTERNAL：内网属性。默认使用 OPEN（公网负载均衡）。
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 仅适用于公网负载均衡。负载均衡的网络计费模式。

DedicatedCLBListener

DedicatedCLBListener is the Schema for the dedicatedclblisteners API

Field Description Default Validation
apiVersion string networking.cloud.tencent.com/v1alpha1
kind string DedicatedCLBListener
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 DedicatedCLBListenerSpec
status DedicatedCLBListenerStatus

DedicatedCLBListenerSpec

DedicatedCLBListenerSpec defines the desired state of DedicatedCLBListener

Appears in:

Field Description Default Validation
lbId string CLB 实例的 ID。
lbRegion string CLB 所在地域，不填则使用 TKE 集群所在的地域。
lbPort integer CLB 监听器的端口号。
lbEndPort integer CLB 端口段监听器的结束端口号。
protocol string CLB 监听器的协议。 Enum: [TCP UDP]
extensiveParameters string 创建监听器的参数，JSON 格式，详细参数请参考 CreateListener 接口：https://cloud.tencent.com/document/api/214/30693
targetPod TargetPod CLB 监听器绑定的目标 Pod。

DedicatedCLBListenerStatus

DedicatedCLBListenerStatus defines the observed state of DedicatedCLBListener

Appears in:

Field Description Default Validation
listenerId string CLB 监听器的 ID。
state string CLB 监听器的状态。 Enum: [Bound Available Pending Failed Deleting]
message string 记录 CLB 监听器的失败信息。
address string CLB 监听器的外部地址。

DedicatedCLBService

DedicatedCLBService is the Schema for the dedicatedclbservices API

Field Description Default Validation
apiVersion string networking.cloud.tencent.com/v1alpha1
kind string DedicatedCLBService
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 DedicatedCLBServiceSpec
status DedicatedCLBServiceStatus

DedicatedCLBServicePort

Appears in:

Field Description Default Validation
protocol string 端口协议，支持 TCP、UDP。
targetPort integer 目标端口。
addressPodAnnotation string Pod 外部地址的注解，如果设置，Pod 被映射的外部 CLB 地址将会被自动写到 Pod 的该注解中，Pod 内部可通过 Downward API 感知到自身的外部地址。

DedicatedCLBServiceSpec

DedicatedCLBServiceSpec defines the desired state of DedicatedCLBService

Appears in:

Field Description Default Validation
lbRegion string CLB 所在地域，不填则使用 TKE 集群所在的地域。
vpcId string CLB 所在 VPC ID，不填则使用 TKE 集群所在的 VPC 的 ID。
minPort integer CLB 端口范围的最小端口号。 500
maxPort integer CLB 端口范围的最大端口号。 50000
maxPod integer 限制单个 CLB 的 Pod/监听器 的最大数量。
selector object (keys:string, values:string) Pod 的标签选择器，被选中的 Pod 会被绑定到 CLB 监听器下。
ports DedicatedCLBServicePort array Pod 监听的端口。
listenerExtensiveParameters string 创建监听器的参数，JSON 格式，详细参数请参考 CreateListener 接口：https://cloud.tencent.com/document/api/214/30693
existedLbIds string array 复用的已有的 CLB ID，可动态追加。
lbAutoCreate LbAutoCreate 启用自动创建 CLB 的功能。

DedicatedCLBServiceStatus

DedicatedCLBServiceStatus defines the observed state of DedicatedCLBService

Appears in:

Field Description Default Validation
allocatableLb AllocatableCLBInfo array 可分配端口的 CLB 列表
allocatedLb AllocatedCLBInfo array 已分配完端口的 CLB 列表

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]

LbAutoCreate

Appears in:

Field Description Default Validation
enable boolean 是否启用自动创建 CLB 的功能，如果启用，当 CLB 不足时，会自动创建新的 CLB。
extensiveParameters string 创建 CLB 时的参数，JSON 格式，详细参数请参考 CreateLoadBalancer 接口：https://cloud.tencent.com/document/api/214/30692

LoadBalancerStatus

LoadBalancerStatus 定义负载均衡器状态

Appears in:

Field Description Default Validation
autoCreated boolean
loadbalancerID string
loadbalancerName string
ips string array
hostname string

PortBindingStatus

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

Appears in:

Field Description Default Validation
port integer 应用端口
protocol string 协议类型
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]
pools string array 使用的端口池列表
useSamePortAcrossPools boolean 是否跨端口池分配相同端口号

TagInfo

TagInfo 定义标签结构

Appears in:

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

TargetPod

Appears in:

Field Description Default Validation
podName string Pod 的名称。
targetPort integer Pod 监听的端口。