tencentcloud-sdk-nodejs
Version:
2,564 lines (2,562 loc) • 412 kB
TypeScript
/**
* DescribeClusterEndpointVipStatus请求参数结构体
*/
export interface DescribeClusterEndpointVipStatusRequest {
/**
* 集群ID
*/
ClusterId: string;
}
/**
* DescribeClusterSecurity请求参数结构体
*/
export interface DescribeClusterSecurityRequest {
/**
* 集群 ID,请填写 查询集群列表 接口中返回的 clusterId 字段
*/
ClusterId: string;
}
/**
* EKS Instance Volume, 可选包括CbsVolume和NfsVolume
*/
export interface EksCiVolume {
/**
* Cbs Volume
注意:此字段可能返回 null,表示取不到有效值。
*/
CbsVolumes?: Array<CbsVolume>;
/**
* Nfs Volume
注意:此字段可能返回 null,表示取不到有效值。
*/
NfsVolumes?: Array<NfsVolume>;
}
/**
* GetTkeAppChartList请求参数结构体
*/
export interface GetTkeAppChartListRequest {
/**
* app类型,取值log,scheduler,network,storage,monitor,dns,image,other,invisible
*/
Kind?: string;
/**
* app支持的操作系统,取值arm32、arm64、amd64
*/
Arch?: string;
/**
* 集群类型,取值tke、eks
*/
ClusterType?: string;
}
/**
* DescribeEdgeCVMInstances请求参数结构体
*/
export interface DescribeEdgeCVMInstancesRequest {
/**
* 集群id
*/
ClusterID: string;
/**
* 过滤条件
仅支持cvm-id过滤
*/
Filters?: Array<Filter>;
}
/**
* InstallLogAgent请求参数结构体
*/
export interface InstallLogAgentRequest {
/**
* TKE集群ID
*/
ClusterId: string;
/**
* kubelet根目录
*/
KubeletRootDir?: string;
/**
* 集群类型 tke/eks,默认tke
*/
ClusterType?: string;
}
/**
* DescribeClusterEndpointVipStatus返回参数结构体
*/
export interface DescribeClusterEndpointVipStatusResponse {
/**
* 端口操作状态 (Creating 创建中 CreateFailed 创建失败 Created 创建完成 Deleting 删除中 DeletedFailed 删除失败 Deleted 已删除 NotFound 未发现操作 )
*/
Status?: string;
/**
* 操作失败的原因
*/
ErrorMsg?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteCluster返回参数结构体
*/
export interface DeleteClusterResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 容器状态
*/
export interface ContainerState {
/**
* 容器运行退出码
注意:此字段可能返回 null,表示取不到有效值。
*/
ExitCode?: number;
/**
* 容器运行结束时间
注意:此字段可能返回 null,表示取不到有效值。
*/
FinishTime?: string;
/**
* 容器状态信息
注意:此字段可能返回 null,表示取不到有效值。
*/
Message?: string;
/**
* 容器状态 Reason
注意:此字段可能返回 null,表示取不到有效值。
*/
Reason?: string;
/**
* 容器重启次数
注意:此字段可能返回 null,表示取不到有效值。
*/
RestartCount?: number;
/**
* 容器运行开始时间
注意:此字段可能返回 null,表示取不到有效值。
*/
StartTime?: string;
/**
* 容器状态:created, running, exited, unknown
*/
State?: string;
}
/**
* CreateClusterRouteTable返回参数结构体
*/
export interface CreateClusterRouteTableResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 子网信息
*/
export interface SubnetInfos {
/**
* 子网id
*/
SubnetId: string;
/**
* 子网节点名称
*/
Name: string;
/**
* 安全组id
*/
SecurityGroups?: Array<string>;
/**
* 系统,默认linux
*/
Os?: string;
/**
* 硬件架构,默认amd64
*/
Arch?: string;
}
/**
* DeleteExternalNodePool请求参数结构体
*/
export interface DeleteExternalNodePoolRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 注册节点池ID列表
*/
NodePoolIds: Array<string>;
/**
* 是否强制删除,在注册节点上有pod的情况下,如果选择非强制删除,则删除会失败
*/
Force?: boolean;
}
/**
* EKS Instance CBS volume
*/
export interface CbsVolume {
/**
* 腾讯云cbs盘Id
*/
CbsDiskId: string;
/**
* cbs volume 数据卷名称
*/
Name: string;
}
/**
* DescribeAddon返回参数结构体
*/
export interface DescribeAddonResponse {
/**
* addon列表
*/
Addons?: Array<Addon>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeEKSClusters请求参数结构体
*/
export interface DescribeEKSClustersRequest {
/**
* 集群ID列表(为空时,
表示获取账号下所有集群)
*/
ClusterIds?: Array<string>;
/**
* 偏移量,默认0
*/
Offset?: number;
/**
* 最大输出条数,默认20
*/
Limit?: number;
/**
* 过滤条件,当前只支持按照单个条件ClusterName进行过滤
*/
Filters?: Array<Filter>;
}
/**
* DescribePrometheusInstancesOverview请求参数结构体
*/
export interface DescribePrometheusInstancesOverviewRequest {
/**
* 用于分页
*/
Offset?: number;
/**
* 用于分页
*/
Limit?: number;
/**
* 过滤实例,目前支持:
ID: 通过实例ID来过滤
Name: 通过实例名称来过滤
*/
Filters?: Array<Filter>;
}
/**
* ServiceAccount认证相关配置
*/
export interface ServiceAccountAuthenticationOptions {
/**
* 使用TKE默认issuer和jwksuri
注意:此字段可能返回 null,表示取不到有效值。
*/
UseTKEDefault?: boolean;
/**
* service-account-issuer
注意:此字段可能返回 null,表示取不到有效值。
*/
Issuer?: string;
/**
* service-account-jwks-uri
注意:此字段可能返回 null,表示取不到有效值。
*/
JWKSURI?: string;
/**
* 如果为true,则会自动创建允许匿名用户访问'/.well-known/openid-configuration'和/openid/v1/jwks的rbac规则
注意:此字段可能返回 null,表示取不到有效值。
*/
AutoCreateDiscoveryAnonymousAuth?: boolean;
}
/**
* ModifyOpenPolicyList返回参数结构体
*/
export interface ModifyOpenPolicyListResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 执行步骤信息
*/
export interface Step {
/**
* 名称
*/
Name?: string;
/**
* 开始时间
注意:此字段可能返回 null,表示取不到有效值。
*/
StartAt?: string;
/**
* 结束时间
注意:此字段可能返回 null,表示取不到有效值。
*/
EndAt?: string;
/**
* 当前状态
*/
Status?: string;
/**
* 执行信息
*/
Message?: string;
/**
* 错误详情
*/
Detail?: string;
}
/**
* 日志开关详细信息
*/
export interface SwitchInfo {
/**
* 开启标识符 true代表开启
*/
Enable?: boolean;
/**
* 获取日志状态失败时,返回错误信息
*/
ErrorMsg?: string;
/**
* CLS日志集ID
*/
LogsetId?: string;
/**
* 日志主题状态,opened表示已开启,opening开启中,closed表示已关闭,closing 表示关闭中
*/
Status?: string;
/**
* CLS日志主题ID
*/
TopicId?: string;
/**
* CLS日志主题所属region
*/
TopicRegion?: string;
/**
* 是否可升级
*/
UpgradeAble?: boolean;
/**
* 当前log-agent版本
*/
Version?: string;
}
/**
* DescribeEdgeClusterInstances返回参数结构体
*/
export interface DescribeEdgeClusterInstancesResponse {
/**
* 该集群总数
*/
TotalCount?: number;
/**
* 节点信息集合
*/
InstanceInfoSet?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpgradeClusterRelease请求参数结构体
*/
export interface UpgradeClusterReleaseRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 自定义的应用名称
*/
Name: string;
/**
* 应用命名空间
*/
Namespace: string;
/**
* 制品名称或从第三方repo 安装chart时,制品压缩包下载地址, 不支持重定向类型chart 地址,结尾为*.tgz
*/
Chart: string;
/**
* 自定义参数,覆盖chart 中values.yaml 中的参数
*/
Values?: ReleaseValues;
/**
* 制品来源,范围:tke-market 或 other 默认值:tke-market,示例值:tke-market
*/
ChartFrom?: string;
/**
* 制品版本( 从第三方安装时,不传这个参数)
*/
ChartVersion?: string;
/**
* 制品仓库URL地址
*/
ChartRepoURL?: string;
/**
* 制品访问用户名
*/
Username?: string;
/**
* 制品访问密码
*/
Password?: string;
/**
* 制品命名空间,ChartFrom为tke-market时ChartNamespace不为空,值为DescribeProducts接口反馈的Namespace
*/
ChartNamespace?: string;
/**
* 集群类型,支持传 tke, eks, tkeedge, external(注册集群)
*/
ClusterType?: string;
}
/**
* addon的具体描述
*/
export interface Addon {
/**
* addon名称
*/
AddonName?: string;
/**
* addon的版本
*/
AddonVersion?: string;
/**
* addon的参数,是一个json格式的base64转码后的字符串
*/
RawValues?: string;
/**
* addon的状态:
- Installing:安装中
- Upgrading:升级中
- Terminating:删除中
- Succeeded:安装/升级成功
- InstallFailed:安装失败
- UpgradFailed:升级失败
*/
Phase?: string;
/**
* addon失败的原因
*/
Reason?: string;
/**
* addon的创建时间
*/
CreateTime?: string;
}
/**
* opa策略信息
*/
export interface OpenPolicyInfo {
/**
* 策略分类:cluster集群策略、node节点策略、namespace命名空间策略、configuration配置相关策略、compute计算资源策略、storage存储资源策略、network网络资源策略
*/
PolicyCategory?: string;
/**
* 策略中文名称
*/
PolicyName?: string;
/**
* 策略描述
*/
PolicyDesc?: string;
/**
* 策略运行模式:dryrun空跑不生效,deny拦截生效
*/
EnforcementAction?: string;
/**
* 关联的事件数量(最近7d)
*/
EventNums?: number;
/**
* 策略英文名称
*/
Name?: string;
/**
* 策略模板类型,支持的类型如下:
优选策略:
blocknamespacedeletion:存在pod的命名空间不允许删除
blockcrddeletion:存在cr的crd不允许删除
blockmountablevolumetype:禁止挂载指定的volume类型
disallowalwayspullimage:禁止镜像拉取策略使用Always
tkeallowedrepos:容器镜像来源限制
blockunknowndaemonset:禁止未知的DaemonSet部署
blockpvdeletion:PV处于绑定状态则不允许删除
corednsprotect:CoreDNS组件删除保护
blockschedulablenodedelete:非封锁状态的Node不允许删除
resourcesdeletionprotection:资源删除保护
tkeenirequest:弹性网卡资源配置限制
blockworkloadcrossversionupgrade:工作负载镜像版本升级策略管控
blockserviceaccountgranthighprivilegepermission:ServiceAccount权限管控
blockclusteripserviceexist:不允许Service为ClusterIP类型
blockinternetaccess:禁止公网访问
assign:禁止访问Metadata Server
blockhostnetworkpod:禁止创建HostNetwork类型Pod
可选策略:
blockvolumemountpath:禁止容器挂载指定的目录
k8sallowedrepos:容器镜像必须以指定字符串列表中的字符串开头
k8sblockendpointeditdefaultrole:禁止默认ClusterRole修改Endpoints
k8sblockloadbalancer:不允许Service为LoadBalancer类型
k8sblocknodeport:不允许Service为NodePort类型
k8sblockwildcardingress:禁止ingress配置空白或通配符类型的hostname
k8scontainerlimits:限制容器必须设置CPU和内存Limit
k8scontainerratios:限制CPU和内存的Request与Limit的最大比率
k8scontainerrequests:限制CPU和内存的Request必须设置且小于配置的最大值
k8srequiredresources:必须配置内存的Limit,CPU和内存的Request
k8sdisallowanonymous:不允许将白名单以外的ClusterRole和Role关联到system:anonymous User和system:unauthenticated Group
k8sdisallowedtags:约束容器镜像tag
k8sexternalips:限制服务externalIP仅为允许的IP地址列表
k8simagedigests:容器镜像必须包含digest
noupdateserviceaccount:拒绝白名单外的资源更新ServiceAccount
k8sreplicalimits:要求具有spec.replicas字段的对象(Deployments、ReplicaSets等)在定义的范围内
k8srequiredannotations:要求资源包含指定的annotations,其值与提供的正则表达式匹配
k8srequiredlabels:要求资源包含指定的标签,其值与提供的正则表达式匹配
k8srequiredprobes:要求Pod具有Readiness或Liveness Probe
k8spspautomountserviceaccounttokenpod:约束容器不能设置automountServiceAccountToken为true
k8spspallowprivilegeescalationcontainer:约束PodSecurityPolicy中的allowPrivilegeEscalation字段为false
k8spspapparmor:约束AppArmor字段列表
k8spspcapabilities:限制PodSecurityPolicy中的allowedCapabilities和requiredDropCapabilities字段
k8spspflexvolumes:约束PodSecurityPolicy中的allowedFlexVolumes字段类型
k8spspforbiddensysctls:约束PodSecurityPolicy中的sysctls字段不能使用的name
k8spspfsgroup:控制PodSecurityPolicy中的fsGroup字段在限制范围内
k8spsphostfilesystem:约束PodSecurityPolicy中的hostPath字段的参数
k8spsphostnamespace:限制PodSecurityPolicy中的hostPID和hostIPC字段
k8spsphostnetworkingports:约束PodSecurityPolicy中的hostNetwork和hostPorts字段
k8spspprivilegedcontainer:禁止PodSecurityPolicy中的privileged字段为true
k8spspprocmount:约束PodSecurityPolicy中的allowedProcMountTypes字段
k8spspreadonlyrootfilesystem:约束PodSecurityPolicy中的readOnlyRootFilesystem字段
k8spspseccomp:约束PodSecurityPolicy上的seccomp.security.alpha.kubernetes.io/allowedProfileNames注解
k8spspselinuxv2:约束Pod定义SELinux配置的允许列表
k8spspallowedusers:约束PodSecurityPolicy中的runAsUser、runAsGroup、supplementalGroups和fsGroup字段
k8spspvolumetypes:约束PodSecurityPolicy中的volumes字段类型
*/
Kind?: string;
/**
* 策略开关状态:open打开,close关闭
*/
EnabledStatus?: string;
/**
* 策略的实例的yaml示例base64编码
*/
ConstraintYamlExample?: string;
/**
* 策略关联的实例列表
注意:此字段可能返回 null,表示取不到有效值。
*/
OpenConstraintInfoList?: Array<OpenConstraintInfo>;
}
/**
* DescribeEdgeClusterUpgradeInfo请求参数结构体
*/
export interface DescribeEdgeClusterUpgradeInfoRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 要升级到的TKEEdge版本
*/
EdgeVersion: string;
}
/**
* 不同角色的节点配置参数
*/
export interface RunInstancesForNode {
/**
* 节点角色,取值:MASTER_ETCD, WORKER。MASTER_ETCD只有在创建 INDEPENDENT_CLUSTER 独立集群时需要指定。MASTER_ETCD节点数量为3~7,建议为奇数。MASTER_ETCD节点最小配置为4C8G。
*/
NodeRole: string;
/**
* CVM创建透传参数,json化字符串格式,详见[CVM创建实例](https://cloud.tencent.com/document/product/213/15730)接口,传入公共参数外的其他参数即可,其中ImageId会替换为TKE集群OS对应的镜像。
*/
RunInstancesPara: Array<string>;
/**
* 节点高级设置,该参数会覆盖集群级别设置的InstanceAdvancedSettings,和上边的RunInstancesPara按照顺序一一对应(当前只对节点自定义参数ExtraArgs生效)。
*/
InstanceAdvancedSettingsOverrides?: Array<InstanceAdvancedSettings>;
}
/**
* DisableVpcCniNetworkType返回参数结构体
*/
export interface DisableVpcCniNetworkTypeResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 可被预留券抵扣的 Pod 某种规格的抵扣率
*/
export interface PodDeductionRate {
/**
* Pod的 CPU
*/
Cpu?: number;
/**
* Pod 的内存,单位:GiB
*/
Memory?: number;
/**
* Pod 的类型, intel,amd,windows-common,windows-amd,sa4,sa5,s7,s8,t4,v100,l20,l40,a10\*gnv4,a10\*gnv4v,a10\*pnv4
*/
Type?: string;
/**
* Pod 的 GPU 卡数,Pod 类型为 GPU 时有效。
*/
GpuNum?: string;
/**
* 这种规格的 Pod总数
*/
TotalNum?: number;
/**
* 这种规格的 Pod被预留券抵扣的数量
*/
DeductionNum?: number;
}
/**
* DescribeClusterControllers返回参数结构体
*/
export interface DescribeClusterControllersResponse {
/**
* 描述集群中各个控制器的状态
*/
ControllerStatusSet?: Array<ControllerStatus>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeExistedInstances请求参数结构体
*/
export interface DescribeExistedInstancesRequest {
/**
* 集群 ID,请填写查询集群列表 接口中返回的 ClusterId 字段(仅通过ClusterId获取需要过滤条件中的VPCID。节点状态比较时会使用该地域下所有集群中的节点进行比较。参数不支持同时指定InstanceIds和ClusterId。
*/
ClusterId?: string;
/**
* 按照一个或者多个实例ID查询。实例ID形如:ins-xxxxxxxx。(此参数的具体格式可参考API简介的id.N一节)。每次请求的实例的上限为100。参数不支持同时指定InstanceIds和Filters。
*/
InstanceIds?: Array<string>;
/**
* 过滤条件,字段和详见[CVM查询实例](https://cloud.tencent.com/document/api/213/15728)如果设置了ClusterId,会附加集群的VPCID作为查询字段,在此情况下如果在Filter中指定了"vpc-id"作为过滤字段,指定的VPCID必须与集群的VPCID相同。
*/
Filters?: Array<Filter>;
/**
* 实例IP进行过滤(同时支持内网IP和外网IP)
*/
VagueIpAddress?: string;
/**
* 实例名称进行过滤
*/
VagueInstanceName?: string;
/**
* 偏移量,默认为0。关于Offset的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
*/
Offset?: number;
/**
* 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
*/
Limit?: number;
/**
* 根据多个实例IP进行过滤
*/
IpAddresses?: Array<string>;
}
/**
* DeletePrometheusClusterAgent请求参数结构体
*/
export interface DeletePrometheusClusterAgentRequest {
/**
* agent列表
*/
Agents: Array<PrometheusAgentInfo>;
/**
* 实例id
*/
InstanceId: string;
/**
* 在7天可回收期间,强制解除绑定
*/
Force?: boolean;
}
/**
* 集群等级变配记录
*/
export interface ClusterLevelChangeRecord {
/**
* 记录ID
*/
ID?: string;
/**
* 集群ID
*/
ClusterID?: string;
/**
* 变配状态:trading 发货中,upgrading 变配中,success 变配成功,failed 变配失败。
*/
Status?: string;
/**
* 状态描述
*/
Message?: string;
/**
* 变配前规模
*/
OldLevel?: string;
/**
* 变配后规模
*/
NewLevel?: string;
/**
* 变配触发类型:manual 手动,auto 自动
*/
TriggerType?: string;
/**
* 创建时间
*/
CreatedAt?: string;
/**
* 开始时间
*/
StartedAt?: string;
/**
* 结束时间
*/
EndedAt?: string;
}
/**
* ModifyMasterComponent请求参数结构体
*/
export interface ModifyMasterComponentRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* master组件名称,支持kube-apiserver、kube-scheduler、kube-controller-manager
*/
Component: string;
/**
* 停机或恢复,值只能为:shutdown或restore
*/
Operation: string;
/**
* 为true时,不真正执行停机或恢复操作
*/
DryRun?: boolean;
}
/**
* ModifyPrometheusAlertRule返回参数结构体
*/
export interface ModifyPrometheusAlertRuleResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeUpgradeTasks请求参数结构体
*/
export interface DescribeUpgradeTasksRequest {
/**
* 偏移量,默认为0
*/
Offset?: number;
/**
* 最大输出条目数,默认为20
*/
Limit?: number;
}
/**
* DescribeEKSContainerInstanceEvent返回参数结构体
*/
export interface DescribeEKSContainerInstanceEventResponse {
/**
* 事件集合
*/
Events?: Array<Event>;
/**
* 容器实例id
*/
EksCiId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 集群路由表对象
*/
export interface RouteTableInfo {
/**
* 路由表名称。
*/
RouteTableName?: string;
/**
* 路由表CIDR。
*/
RouteTableCidrBlock?: string;
/**
* VPC实例ID。
*/
VpcId?: string;
}
/**
* 调度策略权重
*/
export interface SchedulerPolicyPriority {
/**
* 打分函数名称
*/
Name?: string;
/**
* 权重
*/
Weight?: number;
}
/**
* EnableClusterDeletionProtection返回参数结构体
*/
export interface EnableClusterDeletionProtectionResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 集群关联的伸缩组信息
*/
export interface ClusterAsGroup {
/**
* 伸缩组ID
*/
AutoScalingGroupId?: string;
/**
* 伸缩组状态(开启 enabled 开启中 enabling 关闭 disabled 关闭中 disabling 更新中 updating 删除中 deleting 开启缩容中 scaleDownEnabling 关闭缩容中 scaleDownDisabling)
*/
Status?: string;
/**
* 节点是否设置成不可调度
*/
IsUnschedulable?: boolean;
/**
* 伸缩组的label列表
*/
Labels?: Array<Label>;
/**
* 创建时间
*/
CreatedTime?: string;
}
/**
* DeleteRollOutSequence返回参数结构体
*/
export interface DeleteRollOutSequenceResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 云原生Prometheus模板可修改项
*/
export interface PrometheusTempModify {
/**
* 修改名称
*/
Name?: string;
/**
* 修改描述
注意:此字段可能返回 null,表示取不到有效值。
*/
Describe?: string;
/**
* 当Level为cluster时有效,
模板中的ServiceMonitor规则列表
注意:此字段可能返回 null,表示取不到有效值。
*/
ServiceMonitors?: Array<PrometheusConfigItem>;
/**
* 当Level为cluster时有效,
模板中的PodMonitors规则列表
注意:此字段可能返回 null,表示取不到有效值。
*/
PodMonitors?: Array<PrometheusConfigItem>;
/**
* 当Level为cluster时有效,
模板中的RawJobs规则列表
注意:此字段可能返回 null,表示取不到有效值。
*/
RawJobs?: Array<PrometheusConfigItem>;
/**
* 当Level为instance时有效,
模板中的聚合规则列表
注意:此字段可能返回 null,表示取不到有效值。
*/
RecordRules?: Array<PrometheusConfigItem>;
/**
* 修改内容,只有当模板类型是Alert时生效
注意:此字段可能返回 null,表示取不到有效值。
*/
AlertDetailRules?: Array<PrometheusAlertPolicyItem>;
}
/**
* EnableClusterAudit返回参数结构体
*/
export interface EnableClusterAuditResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyMasterComponent返回参数结构体
*/
export interface ModifyMasterComponentResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateBackupStorageLocation返回参数结构体
*/
export interface CreateBackupStorageLocationResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 集群巡检诊断结果
*/
export interface KubeJarvisStateDiagnostic {
/**
* 诊断开始时间
*/
StartTime?: string;
/**
* 诊断结束时间
*/
EndTime?: string;
/**
* 诊断目录
*/
Catalogues?: Array<KubeJarvisStateCatalogue>;
/**
* 诊断类型
*/
Type?: string;
/**
* 诊断名称
*/
Name?: string;
/**
* 诊断描述
*/
Desc?: string;
/**
* 诊断结果列表
*/
Results?: Array<KubeJarvisStateResultsItem>;
/**
* 诊断结果统计
*/
Statistics?: Array<KubeJarvisStateStatistic>;
}
/**
* EnvironmentVariable
*/
export interface EnvironmentVariable {
/**
* key
*/
Name?: string;
/**
* val
*/
Value?: string;
}
/**
* UpdateImageCache请求参数结构体
*/
export interface UpdateImageCacheRequest {
/**
* 镜像缓存ID
*/
ImageCacheId: string;
/**
* 镜像缓存名称
*/
ImageCacheName?: string;
/**
* 镜像仓库凭证数组
*/
ImageRegistryCredentials?: Array<ImageRegistryCredential>;
/**
* 用于制作镜像缓存的容器镜像列表
*/
Images?: Array<string>;
/**
* 镜像缓存的大小。默认为20 GiB。取值范围参考[云硬盘类型](https://cloud.tencent.com/document/product/362/2353)中的高性能云盘类型的大小限制。
*/
ImageCacheSize?: number;
/**
* 镜像缓存保留时间天数,过期将会自动清理,默认为0,永不过期。
*/
RetentionDays?: number;
/**
* 安全组Id
*/
SecurityGroupIds?: Array<string>;
/**
* 腾讯云标签
*/
Tags?: Array<Tag>;
}
/**
* 手动加入的节点
*/
export interface ManuallyAdded {
/**
* 加入中的节点数量
*/
Joining?: number;
/**
* 初始化中的节点数量
*/
Initializing?: number;
/**
* 正常的节点数量
*/
Normal?: number;
/**
* 节点总数
*/
Total?: number;
}
/**
* 标签绑定的资源类型,当前支持类型:"cluster"
*/
export interface Tag {
/**
* 标签键
*/
Key?: string;
/**
* 标签值
*/
Value?: string;
}
/**
* DescribePrometheusAgentInstances请求参数结构体
*/
export interface DescribePrometheusAgentInstancesRequest {
/**
* 集群id
可以是tke, eks, edge的集群id
*/
ClusterId: string;
}
/**
* ModifyClusterAttribute请求参数结构体
*/
export interface ModifyClusterAttributeRequest {
/**
* <p>集群ID</p><p>取值参考:<a href="https://cloud.tencent.com/document/api/457/31862">DescribeClusters</a></p>
*/
ClusterId: string;
/**
* <p>集群所属项目</p>
*/
ProjectId?: number;
/**
* <p>集群名称,字符长度50</p>
*/
ClusterName?: string;
/**
* <p>集群描述</p>
*/
ClusterDesc?: string;
/**
* <p>集群等级,等级类型:L20、L50、L100、L200、L500、L1000、L3000、L5000</p>
*/
ClusterLevel?: string;
/**
* <p>自动变配集群等级</p>
*/
AutoUpgradeClusterLevel?: AutoUpgradeClusterLevel;
/**
* <p>是否开启QGPU共享</p>
*/
QGPUShareEnable?: boolean;
/**
* <p>集群属性</p>
*/
ClusterProperty?: ClusterProperty;
/**
* <p>集群是否启用高可用模式。用于指导跨可用区资源打散等高可用策略的执行</p>
*/
IsHighAvailability?: boolean;
/**
* <p>集群安全模式配置</p>
*/
SecurityModeConfig?: SecurityModeConfig;
}
/**
* 集群巡检检查结果
*/
export interface KubeJarvisStateInspectionResult {
/**
* 集群ID
*/
ClusterId?: string;
/**
* 诊断开始时间
*/
StartTime?: string;
/**
* 诊断结束时间
*/
EndTime?: string;
/**
* 诊断结果统计
*/
Statistics?: Array<KubeJarvisStateStatistic>;
/**
* 诊断结果详情
*/
Diagnostics?: Array<KubeJarvisStateDiagnostic>;
/**
* 查询巡检报告相关报错
*/
Error?: string;
}
/**
* DescribeClusterRoutes返回参数结构体
*/
export interface DescribeClusterRoutesResponse {
/**
* 符合条件的实例数量。
*/
TotalCount?: number;
/**
* 集群路由对象。
*/
RouteSet?: Array<RouteInfo>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeClusters请求参数结构体
*/
export interface DescribeClustersRequest {
/**
* 集群ID列表(为空时,
表示获取账号下所有集群)
*/
ClusterIds?: Array<string>;
/**
* 偏移量,默认0
*/
Offset?: number;
/**
* 最大输出条数,默认20,最大为100
*/
Limit?: number;
/**
* · "Name":"ClusterName","Values": ["test"] 按照【集群名】进行过滤。 类型:String 必选:否 · "Name":"ClusterType","Values": ["MANAGED_CLUSTER"] 按照【集群类型】进行过滤。 类型:String 必选:否 · "Name":"ClusterStatus","Values": ["Running"] 按照【集群状态】进行过滤。 类型:String 必选:否 · "Name":"vpc-id","Values": ["vpc-2wds9k9p"] 按照【VPC】进行过滤。 类型:String 必选:否 · "Name":"tag-key","Values": ["testKey"] 按照【标签键】进行过滤。 类型:String 必选:否 · "Name":"tag-value","Values": ["testValue"] 按照【标签值】进行过滤。 类型:String 必选:否 · "Name":"Tags","Values": ["product:tke"] 按照【标签键值对】进行过滤。 类型:String 必选:否
*/
Filters?: Array<Filter>;
/**
* 集群类型,托管集群:MANAGED_CLUSTER,独立集群:INDEPENDENT_CLUSTER。
*/
ClusterType?: string;
}
/**
* UpgradeClusterInstances请求参数结构体
*/
export interface UpgradeClusterInstancesRequest {
/**
* <p>集群ID(请登录 <a href="https://console.cloud.tencent.com/tke2">TKE 控制台</a> 获取集群 ID )</p>
*/
ClusterId: string;
/**
* <p>create 表示开始一次升级任务<br>pause 表示停止任务<br>resume表示继续任务<br>abort表示终止任务</p>
*/
Operation: string;
/**
* <p>升级类型,只有Operation是create需要设置<br>reset 大版本重装升级<br>hot 小版本热升级<br>major 大版本原地升级</p>
*/
UpgradeType?: string;
/**
* <p>需要升级的节点列表,可以通过控制台或 <a href="https://cloud.tencent.com/document/api/457/50366">查询待升级节点接口</a> 获取</p>
*/
InstanceIds?: Array<string>;
/**
* <p>当节点重新加入集群时候所使用的参数,参考添加已有节点接口</p>
*/
ResetParam?: UpgradeNodeResetParam;
/**
* <p>是否忽略节点升级前检查,默认值 false</p>
*/
SkipPreCheck?: boolean;
/**
* <p>最大可容忍的不可用Pod百分比,如果设置 0 表示不做校验</p><p>取值范围:[0, 100]</p><p>默认值:20</p>
*/
MaxNotReadyPercent?: number;
/**
* <p>是否升级节点运行时,默认false不升级</p>
*/
UpgradeRunTime?: boolean;
/**
* <p>支持多个节点并行升级,默认值为 1,最大并行数为15</p>
*/
Concurrent?: number;
}
/**
* 创建集群时,选择安装的扩展组件的信息
*/
export interface ExtensionAddon {
/**
* 扩展组件名称
*/
AddonName: string;
/**
* 扩展组件信息(扩展组件资源对象的json字符串描述)
*/
AddonParam: string;
}
/**
* DescribeAddonValues请求参数结构体
*/
export interface DescribeAddonValuesRequest {
/**
* 集群ID,请从容器服务控制台集群列表中获取(https://console.cloud.tencent.com/tke2/cluster)。
*/
ClusterId: string;
/**
* addon名称,请从容器服务控制台进入集群详情页后,在组件管理页面中获取。
*/
AddonName: string;
}
/**
* DescribeResourceUsage请求参数结构体
*/
export interface DescribeResourceUsageRequest {
/**
* 集群ID
*/
ClusterId: string;
}
/**
* prometheus聚合规则实例详情,包含所属集群ID
*/
export interface PrometheusRecordRuleYamlItem {
/**
* 实例名称
*/
Name?: string;
/**
* 最近更新时间
*/
UpdateTime?: string;
/**
* Yaml内容
*/
TemplateId?: string;
/**
* 如果该聚合规则来至模板,则TemplateId为模板id
注意:此字段可能返回 null,表示取不到有效值。
*/
Content?: string;
/**
* 该聚合规则如果来源于用户集群crd资源定义,则ClusterId为所属集群ID
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterId?: string;
}
/**
* k8s中标签,一般以数组的方式存在
*/
export interface Label {
/**
* map表中的Name
*/
Name: string;
/**
* map表中的Value
*/
Value: string;
}
/**
* 某机型可支持的最大 VPC-CNI 模式的 Pod 数量
*/
export interface PodLimitsByType {
/**
* TKE共享网卡非固定IP模式可支持的Pod数量
*/
TKERouteENINonStaticIP?: number;
/**
* TKE共享网卡固定IP模式可支持的Pod数量
*/
TKERouteENIStaticIP?: number;
/**
* TKE独立网卡模式可支持的Pod数量
*/
TKEDirectENI?: number;
/**
* TKE中继网卡模式可支持的Pod数量
*/
TKESubENI?: number;
}
/**
* DeletePrometheusTemplateSync请求参数结构体
*/
export interface DeletePrometheusTemplateSyncRequest {
/**
* 模板id
*/
TemplateId: string;
/**
* 取消同步的对象列表
*/
Targets: Array<PrometheusTemplateSyncTarget>;
}
/**
* DisableVpcCniNetworkType请求参数结构体
*/
export interface DisableVpcCniNetworkTypeRequest {
/**
* 集群ID
*/
ClusterId: string;
}
/**
* DescribeClusterReleaseDetails返回参数结构体
*/
export interface DescribeClusterReleaseDetailsResponse {
/**
* 应用详情
*/
Release?: ReleaseDetails;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 自动扩缩容的节点
*/
export interface AutoscalingAdded {
/**
* 正在加入中的节点数量
*/
Joining?: number;
/**
* 初始化中的节点数量
*/
Initializing?: number;
/**
* 正常的节点数量
*/
Normal?: number;
/**
* 节点总数
*/
Total?: number;
}
/**
* SyncPrometheusTemp返回参数结构体
*/
export interface SyncPrometheusTempResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SwitchClusterEndpoint请求参数结构体
*/
export interface SwitchClusterEndpointRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 是否为外网访问(TRUE 外网访问 FALSE 内网访问,默认值: FALSE)
*/
IsExtranet?: boolean;
/**
* 切换回滚至非直连
*/
Rollback?: boolean;
}
/**
* CreateEdgeLogConfig请求参数结构体
*/
export interface CreateEdgeLogConfigRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 日志采集配置的json表达
*/
LogConfig: string;
/**
* CLS日志集ID
*/
LogsetId?: string;
}
/**
* CreatePrometheusDashboard返回参数结构体
*/
export interface CreatePrometheusDashboardResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RotateClusterToken请求参数结构体
*/
export type RotateClusterTokenRequest = null;
/**
* CancelClusterRelease请求参数结构体
*/
export interface CancelClusterReleaseRequest {
/**
* 应用ID
*/
ID: string;
/**
* 集群ID
*/
ClusterId?: string;
/**
* 集群类型,支持传入 tke(标准集群), eks(Serverless集群), external(注册集群)
*/
ClusterType?: string;
}
/**
* DescribeTKEEdgeClusterStatus返回参数结构体
*/
export interface DescribeTKEEdgeClusterStatusResponse {
/**
* 集群当前状态
*/
Phase?: string;
/**
* 集群过程数组
*/
Conditions?: Array<ClusterCondition>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteUserPermissions返回参数结构体
*/
export interface DeleteUserPermissionsResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyClusterAsGroupOptionAttribute请求参数结构体
*/
export interface ModifyClusterAsGroupOptionAttributeRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 集群弹性伸缩属性
*/
ClusterAsGroupOption: ClusterAsGroupOption;
}
/**
* DescribeClusterStatus请求参数结构体
*/
export interface DescribeClusterStatusRequest {
/**
* 集群ID列表,不传默认拉取所有集群
*/
ClusterIds?: Array<string>;
}
/**
* CreateBackupStorageLocation请求参数结构体
*/
export interface CreateBackupStorageLocationRequest {
/**
* 存储仓库所属地域,比如COS广州(ap-guangzhou)
*/
StorageRegion: string;
/**
* 对象存储桶名称,如果是COS必须是tke-backup前缀开头,字符长度是19
*/
Bucket: string;
/**
* 备份仓库名称,字符长度为63
*/
Name: string;
/**
* 存储服务提供方,默认腾讯云
*/
Provider?: string;
/**
* 对象存储桶路径
*/
Path?: string;
}
/**
* CancelUpgradePlan请求参数结构体
*/
export interface CancelUpgradePlanRequest {
/**
* 集群ID
*/
ClusterID: string;
/**
* 升级计划ID
*/
PlanID: number;
}
/**
* prometheus配置
*/
export interface PrometheusConfigItem {
/**
* 名称
*/
Name: string;
/**
* 配置内容
*/
Config: string;
/**
* 用于出参,如果该配置来至模板,则为模板id
注意:此字段可能返回 null,表示取不到有效值。
*/
TemplateId?: string;
}
/**
* DescribeUpgradeTaskDetail请求参数结构体
*/
export interface DescribeUpgradeTaskDetailRequest {
/**
* 升级任务ID
*/
ID: number;
/**
* 偏移量,默认为0
*/
Offset?: number;
/**
* 最大输出条目数,默认为20
*/
Limit?: number;
}
/**
* DeleteClusterNodePool请求参数结构体
*/
export interface DeleteClusterNodePoolRequest {
/**
* 节点池对应的 ClusterId
*/
ClusterId: string;
/**
* 需要删除的节点池 Id 列表
*/
NodePoolIds: Array<string>;
/**
* 删除节点池时是否保留节点池内节点(节点仍然会被移出集群,但对应的实例不会被销毁)
*/
KeepInstance: boolean;
}
/**
* CreateExternalNodePool请求参数结构体
*/
export interface CreateExternalNodePoolRequest {
/**
* 集群Id
*/
ClusterId: string;
/**
* 节点池名称
*/
Name: string;
/**
* 运行时
*/
ContainerRuntime: string;
/**
* 运行时版本
*/
RuntimeVersion: string;
/**
* 注册节点标签
*/
Labels?: Array<Label>;
/**
* 注册节点污点
*/
Taints?: Array<Taint>;
/**
* 注册节点高级设置
*/
InstanceAdvancedSettings?: InstanceAdvancedSettings;
/**
* 删除保护开关
*/
DeletionProtection?: boolean;
/**
* 节点类型,支持 CPU、GPU
*/
NodeType?: string;
}
/**
* ModifyClusterImage返回参数结构体
*/
export interface ModifyClusterImageResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* amp告警渠道配置
*/
export interface PrometheusNotification {
/**
* 是否启用
*/
Enabled: boolean;
/**
* 收敛时间
*/
RepeatInterval: string;
/**
* 生效起始时间
*/
TimeRangeStart: string;
/**
* 生效结束时间
*/
TimeRangeEnd: string;
/**
* 告警通知方式。目前有SMS、EMAIL、CALL、WECHAT方式。
分别代表:短信、邮件、电话、微信
注意:此字段可能返回 null,表示取不到有效值。
*/
NotifyWay?: Array<string>;
/**
* 告警接收组(用户组)
注意:此字段可能返回 null,表示取不到有效值。
*/
ReceiverGroups?: Array<number | bigint>;
/**
* 电话告警顺序。
注:NotifyWay选择CALL,采用该参数。
注意:此字段可能返回 null,表示取不到有效值。
*/
PhoneNotifyOrder?: Array<number | bigint>;
/**
* 电话告警次数。
注:NotifyWay选择CALL,采用该参数。
注意:此字段可能返回 null,表示取不到有效值。
*/
PhoneCircleTimes?: number;
/**
* 电话告警轮内间隔。单位:秒
注:NotifyWay选择CALL,采用该参数。
注意:此字段可能返回 null,表示取不到有效值。
*/
PhoneInnerInterval?: number;
/**
* 电话告警轮外间隔。单位:秒
注:NotifyWay选择CALL,采用该参数。
注意:此字段可能返回 null,表示取不到有效值。
*/
PhoneCircleInterval?: number;
/**
* 电话告警触达通知
注:NotifyWay选择CALL,采用该参数。
注意:此字段可能返回 null,表示取不到有效值。
*/
PhoneArriveNotice?: boolean;
/**
* 通道类型,默认为amp,支持以下
amp
webhook
注意:此字段可能返回 null,表示取不到有效值。
*/
Type?: string;
/**
* 如果Type为webhook, 则该字段为必填项
注意:此字段可能返回 null,表示取不到有效值。
*/
WebHook?: string;
}
/**
* DescribeEKSClusterCredential返回参数结构体
*/
export interface DescribeEKSClusterCredentialResponse {
/**
* 集群的接入地址信息
*/
Addresses?: Array<IPAddress>;
/**
* 集群的认证信息(token只有请求是主账号才返回,子账户请使用返回的kubeconfig)
*/
Credential?: ClusterCredential;
/**
* 集群的公网访问信息
*/
PublicLB?: ClusterPublicLB;
/**
* 集群的内网访问信息
*/
InternalLB?: ClusterInternalLB;
/**
* 标记是否新的内外网功能
*/
ProxyLB?: boolean;
/**
* 连接用户集群k8s 的Config
*/
Kubeconfig?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateClusterMaintenanceWindowAndExclusions返回参数结构体
*/
export interface CreateClusterMaintenanceWindowAndExclusionsResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CheckInstancesUpgradeAble请求参数结构体
*/
export interface CheckInstancesUpgradeAbleRequest {
/**
* 集群ID(请登录 [TKE 控制台](https://console.cloud.tencent.com/tke2) 获取集群 ID )
*/
ClusterId: string;
/**
* 节点列表,空为全部节点
*/
InstanceIds?: Array<string>;
/**
* 升级类型,枚举值:reset(重装升级,支持大版本和小版本),hot(原地滚动小版本升级),major(原地滚动大版本升级)
*/
UpgradeType?: string;
/**
* 偏移量,默认为0。关于 Offset 的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
*/
Offset?: number;
/**
* 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API [简介](https://cloud.tencent.com/document/api/213/15688)中的相关小节。
*/
Limit?: number;
/**
* 过滤条件列表,Name 可选值为ip、instanceId、hostname、label
- Name 为 ip 时,Value 为待查询节点 ip
- Name 为 hostname 时,Value 为待查询节点名称
- Name 为 label 时,Value 为待查询 K8S 节点 label
- Name 为 instanceId 时,Value 为 待查询节点 id
*/
Filter?: Array<Filter>;
}
/**
* ModifyPrometheusTemplate请求参数结构体
*/
export interface ModifyPrometheusTemplateRequest {
/**
* 模板ID
*/
TemplateId: string;
/**
* 修改内容
*/
Template: PrometheusTemplateModify;
}
/**
* DescribeEncryptionStatus请求参数结构体
*/
export interface DescribeEncryptionStatusRequest {
/**
* 集群id
*/
ClusterId: string;
}
/**
* DeleteClusterVirtualNodePool请求参数结构体
*/
export interface DeleteClusterVirtualNodePoolRequest {
/**
* 集群ID,通过DescribeClusters接口获取
*/
ClusterId: string;
/**
* 节点池ID,通过DescribeNodePools接口获取
*/
NodePoolIds: Array<string>;
/**
* 是否强制删除,在超级节点上有pod的情况下,如果选择非强制删除,则删除会失败
*/
Force?: boolean;
}
/**
* DescribeImageCaches请求参数结构体
*/
export interface DescribeImageCachesRequest {
/**
* 镜像缓存Id数组
*/
ImageCacheIds?: Array<string>;
/**
* 镜像缓存名称数组
*/
ImageCacheNames?: Array<string>;
/**
* 限定此次返回资源的数量。如果不设定,默认返回20,最大不能超过50
*/
Limit?: number;
/**
* 偏移量,默认0
*/
Offset?: number;
/**
* 过滤条件,可选条件:
(1)实例名称
KeyName: image-cache-name
类型:String
*/
Filters?: Array<Filter>;
}
/**
* DeleteAddon请求参数结构体
*/
export interface DeleteAddonRequest {
/**
* 集群ID,请从容器服务控制台集群列表中获取(https://console.cloud.tencent.com/tke2/cluster)。
*/
ClusterId: string;
/**
* addon名称,请从容器服务控制台进入集群详情页后,在组件管理页面中获取。
*/
AddonName: string;
}
/**
* DescribeUpgradeTasks返回参数结构体
*/
export interface DescribeUpgradeTasksResponse {
/**
* 升级任务
*/
UpgradeTasks?: Array<UpgradeTask>;
/**
* 总条目数
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeEdgeAvailableExtraArgs请求参数结构体
*/
export interface DescribeEdgeAvailableExtraArgsRequest {
/**
* 集群版本
*/
ClusterVersion?: string;
}
/**
* 已经存在的实例信息
*/
export interface ExistedInstance {
/**
* 实例是否支持加入集群(TRUE 可以加入 FALSE 不能加入)。
*/
Usable?: boolean;
/**
* 实例不支持加入的原因。
*/
UnusableReason?: string;
/**
* 实例已经所在的集群ID。
*/
AlreadyInCluster?: string;
/**
* 实例ID形如:ins-e55paxnt。
*/
InstanceId?: string;
/**
* 实例名称。
*/
InstanceName?: string;
/**
* 实例主网卡的内网IP列表。
注意:此字段可能返回 null,表示取不到有效值。
*/
PrivateIpAddresses?: Array<string>;
/**
* 实例主网卡的公网IP列表。
注意:此字段可能返回 null,表示取不到有效值。
注意:此字段可能返回 null,表示取不到有效值。
*/
PublicIpAddresses?: Array<string>;
/**
* 创建时间。按照ISO8601标准表示,并且使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。
*/
CreatedTime?: string;
/**
* 实例的CPU核数,单位:核。
*/
CPU?: number;
/**
* 实例内存容量,单位:GB。
*/
Memory?: number;
/**
* 操作系统名称。
*/
OsName?: string;
/**
* 实例机型。
*/
InstanceType?: string;
/**
* 伸缩组ID
*/
AutoscalingGroupId?: string;
/**
* 实例计费模式。取值范围: PREPAID:表示预付费,即包年包月 POSTPAID_BY_HOUR:表示后付费,即按量计费 CDHPAID:CDH付费,即只对CDH计费,不对CDH上的实例计费。
*/
InstanceChargeType?: string;
/**
* 实例的IPv6地址。
注意:此字段可能返回 null,表示取不到有效值。
注意:此字段可能返回 null,表示取不到有效值。
*/
IPv6Addresses?: Array<string>;
}
/**
* CreateReservedInstances返回参数结构体
*/
export interface CreateReservedInstancesResponse {
/**
* 预留券实例 ID。
*/
ReservedInstanceIds?: Array<string>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AddNodeToNodePool返回参数结构体
*/
export interface AddNodeToNodePoolResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribePostNodeResources请求参数结构体
*/
export interface DescribePostNodeResourcesRequest {
/**
* 集群 ID
*/
ClusterId: string;
/**
* 节点名称
*/
NodeName?: string;
}
/**
* 托管prometheusV2实例概览
*/
export interface PrometheusInstancesOverview {
/**
* 实例ID
*/
InstanceId?: string;
/**
* 实例名
*/
InstanceName?: string;
/**
* VPC ID
*/
VpcId?: string;
/**
* 子网ID
*/
SubnetId?: string;
/**
* 运行状态(1:正在创建;2:运行中;3:异常;4:重启中;5:销毁中; 6:已停机; 7: 已删除)
*/
InstanceStatus?: number;
/**
* 计费状态(1:正常;2:过期; 3:销毁; 4:分配中; 5:分配失败)
注意:此字段可能返回 null,表示取不到有效值。
*/
ChargeStatus?: number;
/**
* 是否开启 Grafana(0:不开启,1:开启)
*/
EnableGrafana?: number;
/**
* Grafana 面板 URL
注意:此字段可能返回 null,表示取不到有效值。
*/
GrafanaURL?: string;
/**
* 实例付费类型(1:试用版;2:预付费)
*/
InstanceChargeType?: number;
/**
* 规格名称
注意:此字段可能返回 null,表示取不到有效值。
*/
SpecName?: string;
/**
* 存储周期
注意:此字段可能返回 null,表示取不到有效值。
*/
DataRetentionTime?: number;
/**
* 购买的实例过期时间
注意:此字段可能返回 null,表示取不到有效值。
*/
ExpireTime?: string;
/**
* 自动续费标记(0:不自动续费;1:开启自动续费;2:禁止自动续费;-1:无效)
注意:此字段可能返回 null,表示取不到有效值。
*/
AutoRenewFlag?: number;
/**
* 绑定集群总数
*/
BoundTotal?: number;
/**
* 绑定集群正常状态总数
*/
BoundNormal?: number;
}
/**
* DescribePrometheusInstanceInitStatus返回参数结构体
*/
export interface DescribePrometheusInstanceInitStatusResponse {
/**
* 实例初始化状态,取值:
uninitialized 未初始化
initializing 初始化中
running 初始化完成,运行中
注意:此字段可能返回 null,表示取不到有效值。
*/
Status?: string;
/**
* 初始化任务步骤
注意:此字段可能返回 null,表示取不到有效值。
*/
Steps?: Array<TaskStepInfo>;
/**
* 实例eks集群ID
注意:此字段可能返回 null,表示取不到有效值。
*/
EksClusterId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DisableEventPersistence返回参数结构体
*/
export interface DisableEventPersistenceResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* UpdateEKSContainerInstance请求参数结构体
*/
export interface UpdateEKSContainerInstanceRequest {
/**
* 容器实例 ID
*/
EksCiId: string;
/**
* 实例重启策略: Always(总是重启)、Never(从不重启)、OnFailure(失败时重启)
*/
RestartPolicy?: string;
/**
* 数据卷,包含NfsVolume数组和CbsVolume数组
*/
EksCiVolume?: EksCiVolume;
/**
* 容器组
*/
Containers?: Array<Container>;
/**
* Init 容器组
*/
InitContainers?: Array<Container>;
/**
* 容器实例名称
*/
Name?: string;
/**
* 镜像仓库凭证数组
*/
ImageRegistryCredentials?: Array<ImageRegistryCredential>;
}
/**
* cuDNN的版本信息
*/
export interface CUDNN {
/**
* cuDNN的名字
*/
Name: string;
/**
* cuDNN的版本
*/
Version: string;
/**
* cuDNN的Dev名字
*/
DevName?: string;
/**
* cuDNN的Doc名字
*/
DocName?: string;
}
/**
* DescribeReservedInstances返回参数结构体
*/
export interface DescribeReservedInstancesResponse {
/**
* 总数。
*/
TotalCount?: number;
/**
* 预留实例列表。
*/
ReservedInstanceSet?: Array<ReservedInstance>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 集群巡检诊断的默认目录类型
*/
export interface KubeJarvisStateCatalogue {
/**
* 目录级别,支持参数:
first:一级目录
second:二级目录
*/
CatalogueLevel?: string;
/**
* 目录名
*/
CatalogueName?: string;
}
/**
* ModifyClusterTags返回参数结构体
*/
export interface ModifyClusterTagsResponse {
/**
* <p>集群标签</p>
注意:此字段可能返回 null,表示取不到有效值。
*/
Tags?: Array<Tag>;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 服务事件
*/
export interface Event {
/**
* pod名称
*/
PodName?: string;
/**
* 事件原因内容
*/
Reason?: string;
/**
* 事件类型
*/
Type?: string;
/**
* 事件出现次数
*/
Count?: number;
/**
* 事件第一次出现时间
*/
FirstTimestamp?: string;
/**
* 事件最后一次出现时间
*/
LastTimestamp?: string;
/**
* 事件内容
*/
Message?: string;
}
/**
* 探针在容器内执行检测命令参数类型
*/
export interface Exec {
/**
* 容器内检测的命令
注意:此字段可能返回 null,表示取不到有效值。
*/
Commands?: Array<string>;
}
/**
* DescribeEdgeAvailableExtraArgs返回参数结构体
*/
export interface DescribeEdgeAvailableExtraArgsResponse {
/**
* 集群版本
*/
ClusterVersion?: string;
/**
* 可用的自定义参数
注意:此字段可能返回 null,表示取不到有效值。
*/
AvailableExtraArgs?: EdgeAvailableExtraArgs;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 开启注册节点池支持配置信息
*/
export interface ClusterExternalConfig {
/**
* 容器网络类型,支持:HostNetwork、CiliumBGP
*/
NetworkType: string;
/**
* 子网ID
*/
SubnetId: string;
/**
* 集群CIDR,网络模式HostNetwork 时无需填写
注意:此字段可能返回 null,表示取不到有效值。
*/
ClusterCIDR?: string;
/**
* 【已废弃】是否开启专线连接能力
*/
Enabled?: boolean;
}
/**
* CreatePrometheusRecordRuleYaml请求参数结构体
*/
export interface CreatePrometheusRecordRuleYamlRequest {
/**
* 实例id
*/
InstanceId: string;
/**
* yaml的内容
*/
Content: string;
}
/**
* DescribeMasterComponent返回参数结构体
*/
export interface DescribeMasterComponentResponse {
/**
* master组件名称
*/
Component?: string;
/**
* master组件状态,三种状态:running、updating、shutdown
*/
Status?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 集群的实例信息
*/
export interface Instance {
/**
* 实例ID
*/
InstanceId?: string;
/**
* 节点角色, MASTER, WORKER, ETCD, MASTER_ETCD,ALL, 默认为WORKER
*/
InstanceRole?: string;
/**
* 实例异常(或者处于初始化中)的原因
*/
FailedReason?: string;
/**
* 实例的状态(running 运行中,initializing 初始化中,failed 异常)
*/
InstanceState?: string;
/**
* 实例是否封锁状态
*/
DrainStatus?: string;
/**
* 节点配置
*/
InstanceAdvancedSettings?: InstanceAdvancedSettings;
/**
* 添加时间
*/
CreatedTime?: string;
/**
* 节点内网IP
注意:此字段可能返回 null,表示取不到有效值。
*/
LanIP?: string;
/**
* 资源池ID
*/
NodePoolId?: string;
/**
* 自动伸缩组ID
*/
AutoscalingGroupId?: string;
}
/**
* DisableControlPlaneLogs请求参数结构体
*/
export interface DisableControlPlaneLogsRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 集群类型。当前只支持tke
*/
ClusterType: string;
/**
* 组件名称列表,目前支持的组件有:cluster-autoscaler、kapenter
*/
ComponentNames: Array<string>;
/**
* 是否删除日志集和topic。 如果日志集和topic被其他采集规则使用,则不会被删除
*/
DeleteLogSetAndTopic?: boolean;
}
/**
* DescribeOSImages请求参数结构体
*/
export type DescribeOSImagesRequest = null;
/**
* CreateEksLogConfig请求参数结构体
*/
export interface CreateEksLogConfigRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 日志采集配置的json表达
*/
LogConfig: string;
/**
* 日志集ID
*/
LogsetId?: string;
}
/**
* CreateCluster返回参数结构体
*/
export interface CreateClusterResponse {
/**
* <p>集群ID</p>
*/
ClusterId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 关联集群时在集群内部署组件的pod额外配置
*/
export interface PrometheusClusterAgentPodConfig {
/**
* 是否使用HostNetWork
*/
HostNet?: boolean;
/**
* 指定pod运行节点
*/
NodeSelector?: Array<Label>;
/**
* 容忍污点
*/
Tolerations?: Array<Toleration>;
}
/**
* 描述了 “云安全” 服务相关的信息
*/
export interface RunSecurityServiceEnabled {
/**
* 是否开启[云安全](/document/product/296)服务。取值范围:<br><li>true:表示开启云安全服务<br><li>false:表示不开启云安全服务<br><br>默认取值:true。
*/
Enabled?: boolean;
}
/**
* 镜像缓存的信息
*/
export interface ImageCache {
/**
* 镜像缓存Id
*/
ImageCacheId?: string;
/**
* 镜像缓存名称
*/
ImageCacheName?: string;
/**
* 镜像缓存大小。单位:GiB
*/
ImageCacheSize?: number;
/**
* 镜像缓存包含的镜像列表
*/
Images?: Array<string>;
/**
* 创建时间
*/
CreationTime?: string;
/**
* 到期时间
*/
ExpireDateTime?: string;
/**
* 镜像缓存事件信息
*/
Events?: Array<ImageCacheEvent>;
/**
* 最新一次匹配到镜像缓存的时间
*/
LastMatchedTime?: string;
/**
* 镜像缓存对应的快照Id
*/
SnapshotId?: string;
/**
* 镜像缓存状态,可能取值:
Pending:创建中
Ready:创建完成
Failed:创建失败
Updating:更新中
UpdateFailed:更新失败
只有状态为Ready时,才能正常使用镜像缓存
*/
Status?: string;
/**
* 镜像缓存保留时间天数,过期将会自动清理,默认为0,永不过期。
*/
RetentionDays?: number;
/**
* 镜像拉取凭证
*/
ImageRegistryCredentials?: Array<ImageRegistryCredential>;
/**
* 腾讯云标签
*/
Tags?: Array<Tag>;
/**
* 镜像缓存类型
*/
ImageCacheType?: string;
/**
* 镜像缓存所属snapshotter类型
*/
Snapshotter?: string;
}
/**
* DeletePrometheusAlertRule返回参数结构体
*/
export interface DeletePrometheusAlertRuleResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeClusterPendingReleases请求参数结构体
*/
export interface DescribeClusterPendingReleasesRequest {
/**
* 集群ID
*/
ClusterId: string;
/**
* 返回数量限制,默认20,最大100
*/
Limit?: number;
/**
* 偏移量,默认0
*/
Offset?: number;
/**
* 集群类型,支持传入tke(标准集群),eks(Serverless集群),extern