tenyun
Version:
Promise based and chained Tencent Cloud OpenAPI client for NodeJS
2,119 lines (2,012 loc) • 365 kB
TypeScript
/// <reference types="node" />
import { AxiosPromise, AxiosRequestConfig } from "axios";
/** 添加实例到集群的结果 */
declare interface AddInstanceResult {
/** 添加集群失败的节点列表 */
FailedInstanceIds?: string[];
/** 添加集群成功的节点列表 */
SuccInstanceIds?: string[];
/** 添加集群超时的节点列表 */
TimeoutInstanceIds?: string[];
/** 失败的节点的失败原因 */
FailedReasons?: string[] | null;
}
/** 高级选项设置 */
declare interface AdvanceSettings {
/** 子任务单机并发数限制,默认值为2 */
SubTaskConcurrency?: number;
}
/** 亲和规则 */
declare interface Affinity {
/** 亲和性范围 */
Scope?: string;
/** 亲和规则的权重 */
Weight?: string;
/** - */
Paths?: CommonOption[];
}
/** 部署javaagent的类型、版本信息 */
declare interface AgentProfile {
/** Agent类型 */
AgentType?: string;
/** Agent版本号 */
AgentVersion?: string;
}
/** API 对象类型描述 */
declare interface ApiDefinitionDescr {
/** 对象名称 */
Name?: string;
/** 对象属性列表 */
Properties?: PropertyField[];
}
/** API 明细 */
declare interface ApiDetailInfo {
/** API ID */
ApiId?: string | null;
/** 命名空间ID */
NamespaceId?: string | null;
/** 命名空间名称 */
NamespaceName?: string | null;
/** 服务ID */
MicroserviceId?: string | null;
/** 服务名称 */
MicroserviceName?: string | null;
/** API 请求路径 */
Path?: string | null;
/** Api 映射路径 */
PathMapping?: string | null;
/** 请求方法 */
Method?: string | null;
/** 所属分组ID */
GroupId?: string | null;
/** 是否禁用 */
UsableStatus?: string | null;
/** 发布状态 */
ReleaseStatus?: string | null;
/** 开启限流 */
RateLimitStatus?: string | null;
/** 是否开启mock */
MockStatus?: string | null;
/** 创建时间 */
CreatedTime?: string | null;
/** 更新时间 */
UpdatedTime?: string | null;
/** 发布时间 */
ReleasedTime?: string | null;
/** 所属分组名称 */
GroupName?: string | null;
/** API 超时,单位毫秒 */
Timeout?: number | null;
/** Api所在服务host */
Host?: string | null;
/** API类型。 ms : 微服务API; external :外部服务Api */
ApiType?: string | null;
/** Api描述信息 */
Description?: string | null;
/** API路径匹配类型。normal:普通API;wildcard:通配API。 */
ApiMatchType?: string | null;
/** RPC 额外信息 */
RpcExt?: string | null;
/** 部署组id */
GatewayDeployGroupId?: string | null;
/** md5 */
Md5?: string | null;
/** RPC 类型 */
RpcType?: string | null;
}
/** API分组信息 */
declare interface ApiGroupInfo {
/** Api Group Id */
GroupId?: string | null;
/** Api Group 名称 */
GroupName?: string | null;
/** 分组上下文 */
GroupContext?: string | null;
/** 鉴权类型。 secret: 密钥鉴权; none:无鉴权 */
AuthType?: string | null;
/** 发布状态, drafted: 未发布。 released: 发布 */
Status?: string | null;
/** 分组创建时间 如:2019-06-20 15:51:28 */
CreatedTime?: string | null;
/** 分组更新时间 如:2019-06-20 15:51:28 */
UpdatedTime?: string | null;
/** api分组已绑定的网关部署组 */
BindedGatewayDeployGroups?: GatewayDeployGroup[] | null;
/** api 个数 */
ApiCount?: number | null;
/** 访问group的ACL类型 */
AclMode?: string | null;
/** 描述 */
Description?: string | null;
/** 分组类型。 ms: 微服务分组; external:外部Api分组 */
GroupType?: string | null;
/** 网关实例的类型 */
GatewayInstanceType?: string | null;
/** 网关实例ID */
GatewayInstanceId?: string | null;
/** 命名空间参数key值 */
NamespaceNameKey?: string | null;
/** 微服务名参数key值 */
ServiceNameKey?: string | null;
/** 命名空间参数位置,path,header或query,默认是path */
NamespaceNameKeyPosition?: string | null;
/** 微服务名参数位置,path,header或query,默认是path */
ServiceNameKeyPosition?: string | null;
/** 网关实例ID列表 */
GatewayInstanceIdList?: string[] | null;
}
/** 微服务网关API信息 */
declare interface ApiInfo {
/** 命名空间Id,若为外部API,为固定值:"namespace-external" */
NamespaceId: string;
/** 服务Id,若为外部API,为固定值:"ms-external" */
MicroserviceId: string;
/** API path */
Path: string;
/** Api 请求 */
Method: string;
/** 请求映射 */
PathMapping: string;
/** api所在服务host,限定外部Api填写。格式: `http://127.0.0.1:8080` */
Host?: string;
/** api描述信息 */
Description?: string;
}
/** 微服务网关API限流规则 */
declare interface ApiRateLimitRule {
/** rule Id */
RuleId?: string | null;
/** API ID */
ApiId?: string | null;
/** 限流名称 */
RuleName?: string | null;
/** 最大限流qps */
MaxQps?: number | null;
/** 生效/禁用, enabled/disabled */
UsableStatus?: string | null;
/** 规则内容 */
RuleContent?: string | null;
/** Tsf Rule ID */
TsfRuleId?: string | null;
/** 描述 */
Description?: string | null;
/** 创建时间 */
CreatedTime?: string | null;
/** 更新时间 */
UpdatedTime?: string | null;
/** 分页参数limit */
Limit?: number | null;
/** 分页参数offset */
Offset?: number | null;
/** AppId */
AppId?: string | null;
}
/** ApiRequestDescr */
declare interface ApiRequestDescr {
/** 参数名称 */
Name?: string;
/** 参数类型 */
Type?: string;
/** 参数位置 */
In?: string;
/** 参数描述 */
Description?: string;
/** 参数是否必须 */
Required?: boolean;
/** 参数的默认值 */
DefaultValue?: string | null;
}
/** API 响应的参数结构描述 */
declare interface ApiResponseDescr {
/** 参数描述 */
Name?: string;
/** 参数类型 */
Type?: string;
/** 参数描述 */
Description?: string;
}
/** API 日统计数据点 */
declare interface ApiUseStatisticsEntity {
/** 名称 */
Name?: string;
/** 次数 */
Count?: string;
/** 比率 */
Ratio?: string;
}
/** API版本数组 */
declare interface ApiVersionArray {
/** App ID */
ApplicationId?: string | null;
/** App 名称 */
ApplicationName?: string | null;
/** App 包版本 */
PkgVersion?: string | null;
}
/** 应用列表其它字段 */
declare interface ApplicationAttribute {
/** 总实例个数 */
InstanceCount?: number;
/** 运行实例个数 */
RunInstanceCount?: number;
/** 应用下部署组个数 */
GroupCount?: number;
/** 运行中部署组个数 */
RunningGroupCount?: string;
/** 异常部署组个数 */
AbnormalCount?: string;
}
/** 分页的应用描述信息字段 */
declare interface ApplicationForPage {
/** 应用ID */
ApplicationId?: string;
/** 应用名称 */
ApplicationName?: string;
/** 应用描述 */
ApplicationDesc?: string | null;
/** 应用类型 */
ApplicationType?: string;
/** 微服务类型 */
MicroserviceType?: string;
/** 编程语言 */
ProgLang?: string;
/** 创建时间 */
CreateTime?: string;
/** 更新时间 */
UpdateTime?: string;
/** 应用资源类型 */
ApplicationResourceType?: string;
/** 应用runtime类型 */
ApplicationRuntimeType?: string;
/** Apigateway的serviceId */
ApigatewayServiceId?: string;
/** 应用备注名 */
ApplicationRemarkName?: string | null;
/** 服务配置信息列表 */
ServiceConfigList?: ServiceConfig[] | null;
/** IgnoreCreateImageRepository */
IgnoreCreateImageRepository?: boolean;
/** Apm业务系统id */
ApmInstanceId?: string | null;
/** Apm业务系统Name */
ApmInstanceName?: string | null;
/** 同步删除镜像仓库 */
SyncDeleteImageRepository?: boolean | null;
/** 应用微服务子类型 */
MicroserviceSubType?: string | null;
/** 应用编程语言类型 */
ProgramLanguage?: string;
/** 开发框架类型[SpringCloud,Dubbo,Go-GRPC,Other] */
FrameworkType?: string;
/** 注册配置治理信息 */
ServiceGovernanceConfig?: ServiceGovernanceConfig;
/** 微服务类型列表 */
MicroserviceTypeList?: string[] | null;
/** 是否同时创建镜像仓库 */
CreateSameNameImageRepository?: boolean;
}
/** 打散调度规则 */
declare interface AvailableZoneScatterScheduleRule {
/** - */
ScatterDimension?: string;
/** - */
MaxUnbalanceQuantity?: number;
/** - */
IsForceSchedule?: boolean;
/** - */
Paths?: CommonOption[];
}
/** 业务日志配置关联部署组信息 */
declare interface BusinesLogConfigAssociatedGroup {
/** 部署组ID */
GroupId?: string | null;
/** 部署组名称 */
GroupName?: string | null;
/** 部署组所属应用ID */
ApplicationId?: string | null;
/** 部署组所属应用名称 */
ApplicationName?: string | null;
/** 部署组所属应用类型 */
ApplicationType?: string | null;
/** 部署组所属命名空间ID */
NamespaceId?: string | null;
/** 部署组所属命名空间名称 */
NamespaceName?: string | null;
/** 部署组所属集群ID */
ClusterId?: string | null;
/** 部署组所属集群名称 */
ClusterName?: string | null;
/** 部署组所属集群类型 */
ClusterType?: string | null;
/** 部署组关联日志配置时间 */
AssociatedTime?: string | null;
}
/** 业务日志配置 */
declare interface BusinessLogConfig {
/** 配置项ID */
ConfigId?: string;
/** 配置项名称 */
ConfigName?: string;
/** 配置项日志路径 */
ConfigPath?: string;
/** 配置项描述 */
ConfigDesc?: string | null;
/** 配置项标签 */
ConfigTags?: string | null;
/** 配置项对应的ES管道 */
ConfigPipeline?: string;
/** 配置项创建时间,格式为yyyy-MM-dd HH:mm:ss */
ConfigCreateTime?: string | null;
/** 配置项更新时间,格式为yyyy-MM-dd HH:mm:ss */
ConfigUpdateTime?: string | null;
/** 配置项解析规则 */
ConfigSchema?: BusinessLogConfigSchema;
/** 配置项关联部署组 */
ConfigAssociatedGroups?: BusinesLogConfigAssociatedGroup[] | null;
/** 配置项关联部署组 */
ConfigAssociatedGroupList?: BusinessLogConfigAssociatedGroup[];
/** 是否开启filebeat高级配置开关 */
FilebeatConfigEnable?: boolean;
/** close_timeout参数 */
FilebeatCloseTimeout?: number;
/** filebeat ignore_older参数 */
FilebeatIgnoreOlder?: number;
/** filebeat harvester_limit参数 */
FilebeatHarvesterLimit?: number;
/** filebeat close_inactive参数 */
FilebeatCloseInactive?: number;
/** filebeat clean_inactive参数 */
FilebeatCleanInactive?: number;
}
/** 业务日志配置关联部署组信息 */
declare interface BusinessLogConfigAssociatedGroup {
/** 部署组ID */
GroupId: string;
/** 部署组名称 */
GroupName: string;
/** 部署组所属应用ID */
ApplicationId: string;
/** 部署组所属应用名称 */
ApplicationName: string;
/** 部署组所属应用类型,C:容器应用,V:虚拟机应用 */
ApplicationType: string;
/** 部署组所属命名空间ID */
NamespaceId: string;
/** 部署组所属命名空间名称 */
NamespaceName: string;
/** 部署组所属集群ID */
ClusterId: string;
/** 部署组所属集群名称 */
ClusterName: string;
/** 部署组所属集群类型,C:容器集群,V:虚拟机集群 */
ClusterType: string;
/** 部署组关联日志配置时间,格式yyyy-MM-dd HH:mm:ss */
AssociatedTime: string;
}
/** 业务日志配置解析规则 */
declare interface BusinessLogConfigSchema {
/** 解析规则类型。可选值 0(SPRING_BOOT:默认Spring Boot格式),1(NONE:无解析规则),4(NGINX_ACCESS:nginx access日志),5(CUSTOM_LOGBACK:自定义Logback),6(CUSTOM_LOG4J:自定义Log4J),7(CUSTOM_LOG4J2:自定义Log4J2),8(TEXT:单行/多行文本),9(ENVOY_MSGW_ACCESS:envoy access日志)。 */
SchemaType: number;
/** 解析规则内容 */
SchemaContent?: string | null;
/** 解析规则时间格式 */
SchemaDateFormat?: string | null;
/** 解析规则对应的多行匹配规则 */
SchemaMultilinePattern?: string | null;
/** 解析规则创建时间,格式为yyyy-MM-dd HH:mm:ss */
SchemaCreateTime?: string;
/** 用户填写的解析规则 */
SchemaPatternLayout?: string | null;
}
/** 业务日志 */
declare interface BusinessLogV2 {
/** 实例ID */
InstanceId?: string;
/** 日志内容 */
Content?: string;
/** 日志时间戳,单位毫秒 */
Timestamp?: number;
/** 实例IP */
InstanceIp?: string;
/** 日志ID */
LogId?: string;
/** 部署组ID */
GroupId?: string;
}
/** 集群 */
declare interface Cluster {
/** 集群ID */
ClusterId?: string;
/** 集群名称 */
ClusterName?: string;
/** 集群描述 */
ClusterDesc?: string;
/** 集群类型 */
ClusterType?: string;
/** 集群所属私有网络ID */
VpcId?: string;
/** 集群状态 */
ClusterStatus?: string;
/** 集群CIDR */
ClusterCIDR?: string;
/** 集群总CPU,单位: 核 */
ClusterTotalCpu?: number;
/** 集群总内存,单位: G */
ClusterTotalMem?: number;
/** 集群已使用CPU,单位: 核 */
ClusterUsedCpu?: number;
/** 集群已使用内存,单位: G */
ClusterUsedMem?: number;
/** 集群机器实例数量 */
InstanceCount?: number;
/** 集群可用的机器实例数量 */
RunInstanceCount?: number;
/** 集群正常状态的机器实例数量 */
NormalInstanceCount?: number;
/** 删除标记:true:可以删除;false:不可删除 */
DeleteFlag?: boolean;
/** 创建时间 */
CreateTime?: string;
/** 更新时间 */
UpdateTime?: string;
/** 集群所属TSF地域ID */
TsfRegionId?: string;
/** 集群所属TSF地域名称 */
TsfRegionName?: string;
/** 集群所属TSF可用区ID */
TsfZoneId?: string;
/** 集群所属TSF可用区名称 */
TsfZoneName?: string;
/** 集群不可删除的原因 */
DeleteFlagReason?: string;
/** 集群最大CPU限制,单位:核 */
ClusterLimitCpu?: number;
/** 集群最大内存限制,单位:G */
ClusterLimitMem?: number;
/** 集群可用的服务实例数量 */
RunServiceInstanceCount?: number;
/** 集群所属子网ID */
SubnetId?: string;
/** 返回给前端的控制信息 */
OperationInfo?: OperationInfo;
/** 集群版本 */
ClusterVersion?: string;
}
/** 集群详情 */
declare interface ClusterV2 {
/** 集群ID */
ClusterId?: string;
/** 集群名称 */
ClusterName?: string | null;
/** 集群描述 */
ClusterDesc?: string | null;
/** 集群类型,C表示容器集群,V表示虚拟机集群 */
ClusterType?: string | null;
/** 集群所属私有网络ID */
VpcId?: string | null;
/** 集群状态 */
ClusterStatus?: string | null;
/** 集群CIDR */
ClusterCIDR?: string | null;
/** 集群总CPU,单位: 核 */
ClusterTotalCpu?: number | null;
/** 集群总内存,单位: G */
ClusterTotalMem?: number | null;
/** 集群已使用CPU,单位: 核 */
ClusterUsedCpu?: number | null;
/** 集群已使用内存,单位: G */
ClusterUsedMem?: number | null;
/** 集群机器实例数量 */
InstanceCount?: number | null;
/** 集群运行中的机器实例数量 */
RunInstanceCount?: number | null;
/** 集群正常状态的机器实例数量 */
NormalInstanceCount?: number | null;
/** 删除标记:true:可以删除;false:不可删除 */
DeleteFlag?: boolean | null;
/** 创建时间,格式为YYYY-MM-DD HH:MM:SS */
CreateTime?: string | null;
/** 更新时间,格式为YYYY-MM-DD HH:MM:SS */
UpdateTime?: string | null;
/** 集群所属TSF地域ID */
TsfRegionId?: string | null;
/** 集群所属TSF地域名称 */
TsfRegionName?: string | null;
/** 集群所属TSF可用区ID */
TsfZoneId?: string | null;
/** 集群所属TSF可用区名称 */
TsfZoneName?: string | null;
/** 集群不可删除的原因 */
DeleteFlagReason?: string | null;
/** 集群所属私有网络子网ID */
SubnetId?: string | null;
/** 集群剩余 cpu limit */
ClusterLimitCpu?: string | null;
/** 集群剩余 memory limit */
ClusterLimitMem?: string | null;
/** 运行服务实例数 */
RunServiceInstanceCount?: number | null;
/** 给前端的按钮控制信息 */
OperationInfo?: OperationInfo | null;
/** 容器集群版本 */
ClusterVersion?: string | null;
/** 部署组总数 */
GroupCount?: number | null;
/** 运行中部署组数 */
RunGroupCount?: number | null;
/** 停止中部署组数 */
StopGroupCount?: number | null;
/** 异常部署组数 */
AbnormalGroupCount?: number | null;
/** 集群备注名 */
ClusterRemarkName?: string | null;
/** api地址 */
KuberneteApiServer?: string | null;
/** K 表示通过kubeconfig 导入, S 表示通过service account导入 */
KuberneteNativeType?: string | null;
/** Kubernetes 密钥 */
KuberneteNativeSecret?: string | null;
/** 是否开启cls日志功能 */
EnableLogCollection?: boolean;
/** 集群状态的原因 */
Reason?: string;
}
/** 通用选项 */
declare interface CommonOption {
/** - */
LabelName?: string;
/** - */
Operator?: string;
/** - */
LabelValue?: string;
}
/** ValueFrom 通用结构 */
declare interface CommonRef {
/** 名称 */
Name?: string;
/** Key值 */
Key?: string;
}
/** 配置项 */
declare interface Config {
/** 配置项ID */
ConfigId?: string | null;
/** 配置项名称 */
ConfigName?: string | null;
/** 配置项版本 */
ConfigVersion?: string | null;
/** 配置项版本描述 */
ConfigVersionDesc?: string | null;
/** 配置项值 */
ConfigValue?: string | null;
/** 配置项类型 */
ConfigType?: string | null;
/** 创建时间 */
CreationTime?: string | null;
/** 应用ID */
ApplicationId?: string | null;
/** 应用名称 */
ApplicationName?: string | null;
/** 删除标识,true:可以删除;false:不可删除 */
DeleteFlag?: boolean | null;
/** 最后更新时间 */
LastUpdateTime?: string | null;
/** 配置项版本数量 */
ConfigVersionCount?: number | null;
}
/** ConfigMap可选项 */
declare interface ConfigMapOption {
/** - */
Key?: string;
/** - */
Path?: string;
/** - */
Mode?: string;
}
/** 配置项发布信息 */
declare interface ConfigRelease {
/** 配置项发布ID */
ConfigReleaseId?: string | null;
/** 配置项ID */
ConfigId?: string | null;
/** 配置项名称 */
ConfigName?: string | null;
/** 配置项版本 */
ConfigVersion?: string | null;
/** 发布时间 */
ReleaseTime?: string | null;
/** 部署组ID */
GroupId?: string | null;
/** 部署组名称 */
GroupName?: string | null;
/** 命名空间ID */
NamespaceId?: string | null;
/** 命名空间名称 */
NamespaceName?: string | null;
/** 集群ID */
ClusterId?: string | null;
/** 集群名称 */
ClusterName?: string | null;
/** 发布描述 */
ReleaseDesc?: string | null;
/** 应用ID */
ApplicationId?: string | null;
/** 配置中心发布情况 */
ConfigCenters?: TsfConfigCenter[] | null;
/** DUAL_STATUS_WRITE_REGISTRATION_ON 双写&&双注册开启DUAL_STATUS_WRITE_REGISTRATION_OFF 双写&&双注册关闭 */
DaulStatus?: string | null;
}
/** 配置项发布日志 */
declare interface ConfigReleaseLog {
/** 配置项发布日志ID */
ConfigReleaseLogId?: string | null;
/** 配置项ID */
ConfigId?: string | null;
/** 配置项名称 */
ConfigName?: string | null;
/** 配置项版本 */
ConfigVersion?: string | null;
/** 部署组ID */
GroupId?: string | null;
/** 部署组名称 */
GroupName?: string | null;
/** 命名空间ID */
NamespaceId?: string | null;
/** 命名空间名称 */
NamespaceName?: string | null;
/** 集群ID */
ClusterId?: string | null;
/** 集群名称 */
ClusterName?: string | null;
/** 发布时间 */
ReleaseTime?: string | null;
/** 发布描述 */
ReleaseDesc?: string | null;
/** 发布状态 */
ReleaseStatus?: string | null;
/** 上次发布的配置项ID */
LastConfigId?: string | null;
/** 上次发布的配置项名称 */
LastConfigName?: string | null;
/** 上次发布的配置项版本 */
LastConfigVersion?: string | null;
/** 回滚标识 */
RollbackFlag?: boolean | null;
/** 发布成功的配置中心 ALL/EXCLUSIVE/SHARE/NONE全部发布成功,独占发布成功,共享发布成功,全部发布失败 */
ReleasedConfigCenter?: string | null;
}
/** 配置模板对象 */
declare interface ConfigTemplate {
/** 配置模板Id */
ConfigTemplateId?: string | null;
/** 配置模板名称 */
ConfigTemplateName?: string | null;
/** 配置模板描述 */
ConfigTemplateDesc?: string | null;
/** 配置模板对应的微服务框架 */
ConfigTemplateType?: string | null;
/** 配置模板数据 */
ConfigTemplateValue?: string | null;
/** 创建时间 */
CreateTime?: string | null;
/** 更新时间 */
UpdateTime?: string | null;
}
/** 部署组列表(应用下钻界面的) */
declare interface ContainGroup {
/** 部署组ID */
GroupId?: string;
/** 分组名称 */
GroupName?: string;
/** 创建时间 */
CreateTime?: string;
/** 镜像server */
Server?: string;
/** 镜像名,如/tsf/nginx */
RepoName?: string;
/** 镜像版本名称 */
TagName?: string;
/** 集群ID */
ClusterId?: string;
/** 集群名称 */
ClusterName?: string;
/** 命名空间ID */
NamespaceId?: string;
/** 命名空间名称 */
NamespaceName?: string;
/** 初始分配的 CPU 核数,对应 K8S request */
CpuRequest?: string;
/** 最大分配的 CPU 核数,对应 K8S limit */
CpuLimit?: string;
/** 初始分配的内存 MiB 数,对应 K8S request */
MemRequest?: string;
/** 最大分配的内存 MiB 数,对应 K8S limit */
MemLimit?: string;
/** 部署组备注 */
Alias?: string;
/** KubeInjectEnable值 */
KubeInjectEnable?: boolean;
/** 更新时间 */
UpdatedTime?: string;
}
/** 部署组列表(应用下钻) */
declare interface ContainGroupResult {
/** 部署组列表 */
Content?: ContainGroup[];
/** 总记录数 */
TotalCount?: number;
}
/** 应用使用容器部署时需要的额外资源 */
declare interface ContainerAdditionalResourceRequirement {
/** CPU 核数 */
Cpu?: string | null;
/** 内存 MiB 数 */
Mem?: string | null;
}
/** 不同类型的应用的容器部署组,部署时的额外资源要求 */
declare interface ContainerAdditionalResourceRequirementMap {
/** Mesh 应用部署时需要的额外资源 */
M: ContainerAdditionalResourceRequirement | null;
/** 普通应用部署时需要的额外资源 */
N: ContainerAdditionalResourceRequirement | null;
}
/** 返回容器的事件,比如 k8s deployment 或者 pod 的 events */
declare interface ContainerEvent {
/** 第一次出现的时间,以 ms 为单位的时间戳 */
FirstTimestamp?: number;
/** 最后一次出现的时间,以 ms 为单位的时间戳 */
LastTimestamp?: number;
/** 级别 */
Type?: string;
/** Kubernetes 资源类型,典型取值有 Deployment(部署资源)、Pod(容器组)、Service(服务资源) 等 */
Kind?: string;
/** 资源名称 */
Name?: string;
/** 内容 */
Reason?: string;
/** 详细描述 */
Message?: string;
/** 出现次数 */
Count?: number;
}
/** 获取部署组 */
declare interface ContainerGroupDeploy {
/** 部署组id */
GroupId?: string;
/** 分组名称 */
GroupName?: string;
/** 实例总数 */
InstanceNum?: number;
/** 已启动实例总数 */
CurrentNum?: number;
/** 镜像server */
Server?: string | null;
/** 镜像名,如/tsf/nginx */
Reponame?: string | null;
/** 镜像版本名称 */
TagName?: string | null;
/** 业务容器初始分配的 CPU 核数,对应 K8S request */
CpuRequest?: string | null;
/** 业务容器最大分配的 CPU 核数,对应 K8S limit */
CpuLimit?: string | null;
/** 业务容器初始分配的内存 MiB 数,对应 K8S request */
MemRequest?: string | null;
/** 业务容器最大分配的内存 MiB 数,对应 K8S limit */
MemLimit?: string | null;
/** 0:公网 1:集群内访问 2:NodePort */
AccessType?: number | null;
/** 端口映射 */
ProtocolPorts?: ProtocolPort[];
/** 更新方式:0:快速更新 1:滚动更新 */
UpdateType?: number | null;
/** 更新间隔,单位秒 */
UpdateIvl?: number | null;
/** jvm参数 */
JvmOpts?: string | null;
/** 子网id */
SubnetId?: string | null;
/** agent容器初始分配的 CPU 核数,对应 K8S request */
AgentCpuRequest?: string | null;
/** agent容器最大分配的 CPU 核数,对应 K8S limit */
AgentCpuLimit?: string | null;
/** agent容器初始分配的内存 MiB 数,对应 K8S request */
AgentMemRequest?: string | null;
/** agent容器最大分配的内存 MiB 数,对应 K8S limit */
AgentMemLimit?: string | null;
/** istioproxy容器初始分配的 CPU 核数,对应 K8S request */
IstioCpuRequest?: string | null;
/** istioproxy容器最大分配的 CPU 核数,对应 K8S limit */
IstioCpuLimit?: string | null;
/** istioproxy容器初始分配的内存 MiB 数,对应 K8S request */
IstioMemRequest?: string | null;
/** istioproxy容器最大分配的内存 MiB 数,对应 K8S limit */
IstioMemLimit?: string | null;
/** 部署组的环境变量数组,这里没有展示 tsf 使用的环境变量,只展示了用户设置的环境变量。 */
Envs?: Env[] | null;
/** 健康检查配置信息,若不指定该参数,则默认不设置健康检查。 */
HealthCheckSettings?: HealthCheckSettings | null;
/** 是否部署Agent容器 */
DeployAgent?: boolean;
/** 部署组备注 */
Alias?: string | null;
/** 是否创建 k8s service */
DisableService?: boolean;
/** service 是否为 headless 类型 */
HeadlessService?: boolean;
/** TcrRepoInfo值 */
TcrRepoInfo?: TcrRepoInfo | null;
/** 数据卷信息,数组结构 */
VolumeInfos?: VolumeInfo[] | null;
/** 数据卷挂载信息,list */
VolumeMountInfos?: VolumeMountInfo[] | null;
/** KubeInjectEnable值 */
KubeInjectEnable?: boolean | null;
/** 仓库类型 (person, tcr) */
RepoType?: string;
/** 预热配置设置 */
WarmupSetting?: WarmupSetting;
/** Envoy网关服务配置 */
GatewayConfig?: GatewayConfig | null;
/** 容器名称 */
ContainerName?: string;
/** 附加容器列表 */
AdditionalContainerList?: GroupContainerInfo[];
/** 内部容器列表 */
InternalContainerList?: GroupContainerInfo[];
/** service列表 */
ServiceSettingList?: ServiceSetting[];
}
/** 容器部署组详情 */
declare interface ContainerGroupDetail {
/** 部署组ID */
GroupId?: string;
/** 分组名称 */
GroupName?: string;
/** 实例总数 */
InstanceNum?: number | null;
/** 已启动实例总数 */
CurrentNum?: number;
/** 创建时间 */
CreateTime?: string;
/** 镜像server */
Server?: string | null;
/** 镜像名,如/tsf/nginx */
Reponame?: string | null;
/** 镜像版本名称 */
TagName?: string | null;
/** 集群ID */
ClusterId?: string;
/** 集群名称 */
ClusterName?: string;
/** 命名空间ID */
NamespaceId?: string;
/** 命名空间名称 */
NamespaceName?: string;
/** 应用ID */
ApplicationId?: string;
/** 负载均衡ip */
LbIp?: string;
/** 应用类型 */
ApplicationType?: string;
/** Service ip */
ClusterIp?: string;
/** NodePort端口,只有公网和NodePort访问方式才有值 */
NodePort?: number | null;
/** 最大分配的 CPU 核数,对应 K8S limit */
CpuLimit?: string | null;
/** 最大分配的内存 MiB 数,对应 K8S limit */
MemLimit?: string | null;
/** 0:公网 1:集群内访问 2:NodePort */
AccessType?: number | null;
/** 更新方式:0:快速更新 1:滚动更新 */
UpdateType?: number;
/** 更新间隔,单位秒 */
UpdateIvl?: number | null;
/** 端口数组对象 */
ProtocolPorts?: ProtocolPort[];
/** 环境变量数组对象 */
Envs?: Env[];
/** 应用名称 */
ApplicationName?: string;
/** pod错误信息描述 */
Message?: string | null;
/** 部署组状态 */
Status?: string;
/** 服务类型 */
MicroserviceType?: string;
/** 初始分配的 CPU 核数,对应 K8S request */
CpuRequest?: string | null;
/** 初始分配的内存 MiB 数,对应 K8S request */
MemRequest?: string | null;
/** 子网id */
SubnetId?: string | null;
/** 部署组资源类型 */
GroupResourceType?: string;
/** 部署组实例个数 */
InstanceCount?: number;
/** 部署组更新时间戳 */
UpdatedTime?: number;
/** kubernetes滚动更新策略的MaxSurge参数 */
MaxSurge?: string | null;
/** kubernetes滚动更新策略的MaxUnavailable参数 */
MaxUnavailable?: string | null;
/** 部署组健康检查设置 */
HealthCheckSettings?: HealthCheckSettings | null;
/** 允许PlainYamlDeploy */
AllowPlainYamlDeploy?: boolean;
/** 是否不等于ServiceConfig */
IsNotEqualServiceConfig?: boolean | null;
/** 仓库名 */
RepoName?: string | null;
/** 别名 */
Alias?: string | null;
}
/** 可观测配置 */
declare interface ContainerGroupObservabilityConfig {
/** 日志配置项ID列表 */
BusinessLogConfigIdList?: string[] | null;
/** 投递配置项ID列表 */
BusinessLogDeliveryConfigIdList?: string[] | null;
}
/** 部署组列表-其它字段 */
declare interface ContainerGroupOther {
/** 实例总数 */
InstanceNum?: number;
/** 已启动实例总数 */
CurrentNum?: number;
/** 负载均衡DNS地址 */
LbDns?: string;
/** 负载均衡ip */
LbIp?: string;
/** Service ip */
ClusterIp?: string;
/** 服务状态,请参考后面的状态定义 */
Status?: string;
/** 服务状态,请参考后面的状态定义 */
Message?: string;
/** 环境变量 */
Envs?: Env[];
/** Service NodePort */
NodePort?: number | null;
/** 子网ID */
SubnetId?: string | null;
/** 健康检查相关字段 */
HealthCheckSettings?: HealthCheckSettings | null;
/** 服务配置信息是否匹配 */
IsNotEqualServiceConfig?: boolean;
}
/** 容器部署组相关的参数配置 */
declare interface ContainerGroupResourceConfig {
/** 不同类型的应用的容器部署组,部署时的额外资源要求 */
AdditionalResourceRequirement: ContainerAdditionalResourceRequirementMap | null;
}
/** 服务治理相关配置项 */
declare interface ContainerGroupServiceGovernanceConfig {
/** 是否开启服务治理 */
EnableGovernance?: boolean | null;
/** 控制台场景使用 mesh服务配置信息列表 */
ServiceConfigList?: ServiceConfig[] | null;
/** 注册服务治理实例 */
ExclusiveInstances?: ExclusiveInstance[] | null;
/** 服务治理类型 */
GovernanceType?: string | null;
}
/** 容器详细信息 */
declare interface ContainerInfo {
/** 容器名 */
Name?: string | null;
/** 容器ID */
ContainerId?: string | null;
/** 容器状态 */
Status?: string | null;
/** 容器的Reason */
Reason?: string | null;
/** 镜像地址 */
Image?: string | null;
/** 是否为业务主容器 */
IsBusinessMainContainer?: boolean | null;
/** 镜像Server */
Server?: string | null;
/** 镜像名 */
RepoName?: string | null;
/** 仓库类型 */
RepoType?: string | null;
/** TCR 仓库信息 */
TcrRepoInfo?: TcrRepoInfo | null;
/** 容器访问凭证名称 */
SecretName?: string | null;
/** 镜像版本号 */
TagName?: string | null;
/** 健康检查 */
HealthCheckSettings?: HealthCheckSettings | null;
/** 容器Cpu request */
CpuRequest?: string | null;
/** 容器Cpu limit */
CpuLimit?: string | null;
/** 容器Mem request */
MemRequest?: string | null;
/** 容器Mem Limit */
MemLimit?: string | null;
/** 环境变量参数 */
Envs?: Env[] | null;
/** 环境变量参数 */
UserEnvs?: Env[] | null;
/** JVM参数 */
JvmOpts?: string | null;
/** 挂载信息 */
VolumeMountInfoList?: VolumeMountInfo[] | null;
/** 是否为初始化容器 */
InitContainerEnable?: boolean | null;
/** 生命周期钩子 */
LifeCycleHookList?: LifeCycleHook[] | null;
/** 是否为特权容器 */
PrivilegeContainerEnable?: boolean | null;
/** 运行命令 */
RunCommand?: string | null;
/** 运行参数 */
RunArg?: string | null;
/** 容器名称 */
ContainerName?: string | null;
}
/** 容器实例相关的参数配置 */
declare interface ContainerInstanceResourceConfig {
/** 实例导入方式,可多个,公有云为 ["R"],独立版的取值有 "M" 脚本模式、"S" SSH 模式 */
ImportMode?: string[] | null;
/** SSH 模式时,前端应该限制用户填这个数量的 master 主机信息 */
MasterNumLimit?: number | null;
/** SSH 模式时,前端应该限制用户填的最高数量的 node 主机信息 */
NodeNumLimitPerSetup?: number | null;
}
/** cos临时账号信息 */
declare interface CosCredentials {
/** 会话Token */
SessionToken?: string;
/** 临时应用ID */
TmpAppId?: string;
/** 临时调用者身份ID */
TmpSecretId?: string;
/** 临时密钥 */
TmpSecretKey?: string;
/** 过期时间 */
ExpiredTime?: number;
/** 所在域 */
Domain?: string;
}
/** Cos下载所需信息 */
declare interface CosDownloadInfo {
/** 桶名称 */
Bucket?: string;
/** 地域 */
Region?: string;
/** 路径 */
Path?: string;
/** 鉴权信息 */
Credentials?: CosCredentials;
}
/** cos上传所需信息 */
declare interface CosUploadInfo {
/** 程序包ID */
PkgId?: string;
/** 桶 */
Bucket?: string;
/** 目标地域 */
Region?: string;
/** 存储路径 */
Path?: string;
/** 鉴权信息 */
Credentials?: CosCredentials;
}
/** 构成监控数据图的曲线坐标点 */
declare interface CurvePoint {
/** 当前坐标 X轴的值 当前是日期格式:"yyyy-MM-dd HH:mm:ss" */
Label?: string;
/** 当前坐标 Y轴的值 */
Value?: string;
/** 该坐标点时间戳,单位毫秒 */
Timestamp?: string;
}
/** 自定义Pod调度规则 */
declare interface CustomPodSchedule {
/** - */
ForceSchedule?: ForceSchedule;
/** - */
TrySchedule?: TrySchedule;
}
/** 自定义容忍调度规则列表 */
declare interface CustomTolerateSchedule {
/** - */
Key?: string;
/** - */
Operator?: string;
/** - */
Value?: string;
/** - */
Effect?: string;
/** - */
TolerationSeconds?: number;
}
/** 需要删除的镜像版本 */
declare interface DeleteImageTag {
/** 仓库名,如/tsf/nginx */
RepoName: string;
/** 版本号:如V1 */
TagName: string;
}
/** 描述投递配置项绑定的部署组 */
declare interface DeliveryConfigBindGroup {
/** 配置id */
ConfigId: string;
/** 配置名 */
ConfigName: string;
/** 采集路径 */
CollectPath: string[];
/** 关联部署组信息 */
Groups: GroupInfo[];
/** 创建时间,格式yyyy-MM-dd HH:mm:ss */
CreateTime: string;
/** Kafka的vip */
KafkaVIp?: string | null;
/** Kafka地址 */
KafkaAddress?: string | null;
/** Kafka端口 */
KafkaVPort?: string | null;
/** Topic */
Topic?: string;
/** LineRule */
LineRule?: string | null;
/** 自定义规则 */
CustomRule?: string | null;
/** EnableGlobalLineRule */
EnableGlobalLineRule?: boolean | null;
/** 是否开启认证 */
EnableAuth?: boolean;
/** 用户名 */
Username?: string | null;
/** 密码 */
Password?: string | null;
/** KafkaInfos */
KafkaInfos?: DeliveryKafkaInfo[] | null;
}
/** 描述配置项绑定的部署组 */
declare interface DeliveryConfigBindGroups {
/** 公共条数 */
TotalCount?: number;
/** 内容 */
Content?: DeliveryConfigBindGroup[];
}
/** kafka投递的topic和path的信息 */
declare interface DeliveryKafkaInfo {
/** 投递kafka的topic */
Topic?: string;
/** 采集日志的path */
Path?: string[];
/** default,默认换行符分行time,按时间分行custom, 选了custom那么CustomRule就要填入具体的自定义值 */
LineRule?: string;
/** 自定义的分行值 */
CustomRule?: string;
}
/** 部署后返回的结构体 */
declare interface DeployContainerApplicationResp {
/** 部署组ID */
GroupId?: string | null;
/** 任务ID */
TaskId?: string | null;
}
/** 返回给前端的控制信息 */
declare interface DescribeResourceConfigCluster {
/** 返回给前端的控制信息 */
Container: DescribeResourceConfigClusterContainer | null;
}
/** 返回给前端的控制信息 */
declare interface DescribeResourceConfigClusterContainer {
/** 是否需要子网 */
NeedSubnetWhenCreatingCluster?: boolean | null;
}
/** DescribeResourceConfig */
declare interface DescribeResourceConfigLicense {
/** 功能 */
Function?: DescribeResourceConfigLicenseFunction[] | null;
/** 资源 */
Resource?: DescribeResourceConfigLicenseResource[] | null;
/** utc时间 单位秒 */
ExpireTime?: number | null;
/** utc时间 单位秒 */
Countdown?: number | null;
/** 规格 */
Spec?: string | null;
}
/** DescribeResourceConfig */
declare interface DescribeResourceConfigLicenseFunction {
/** 功能名 */
Name?: string | null;
/** 是否启用 */
Enable?: boolean | null;
}
/** DescribeResourceConfig */
declare interface DescribeResourceConfigLicenseResource {
/** Name */
Name?: string | null;
/** Quota */
Quota?: number | null;
}
/** DescribeResourceConfig */
declare interface DescribeResourceConfigResultV2 {
/** STS参数配置 */
Sts: DescribeResourceConfigSts | null;
/** 许可信息 */
License: DescribeResourceConfigLicense | null;
/** 部署组相关的参数配置 */
Group: GroupResourceConfig | null;
/** 实例相关的参数配置 */
Instance: InstanceResourceConfig | null;
/** Cluster相关配置信息 */
Cluster: DescribeResourceConfigCluster | null;
/** 程序包相关配置信息 */
Package: PackageConfig | null;
}
/** DescribeResourceConfig */
declare interface DescribeResourceConfigSts {
/** uin */
Uin?: string | null;
}
/** 空目录选项 */
declare interface EmptyDirOption {
/** - */
EnableMemory?: boolean;
/** - */
StorageCapacity?: number;
/** - */
StorageUnit?: string;
/** - */
SizeLimit?: string;
}
/** 环境变量 */
declare interface Env {
/** 环境变量名称 */
Name: string;
/** 环境变量值 */
Value?: string;
/** k8s ValueFrom */
ValueFrom?: ValueFrom | null;
}
/** 独占实例 */
declare interface ExclusiveInstance {
/** 配置中心类型[注册中心Registration、配置中心Configuration] */
CenterType?: string;
/** 实例id,通过[北极星控制台](https://console.cloud.tencent.com/tse/governance)获取 */
InstanceId?: string;
/** 实例类型,例如北极星Polaris */
InstanceType?: string;
/** 实例名称 */
InstanceName?: string;
/** 实例地域id,通过[北极星控制台](https://console.cloud.tencent.com/tse/governance)获取 */
RegionId?: string;
/** 实例命名空间ID,通过[北极星控制台](https://console.cloud.tencent.com/tse/governance)获取 */
InstanceNamespaceId?: string;
}
/** 容器 env 的 FieldRef */
declare interface FieldRef {
/** k8s 的 FieldPath */
FieldPath?: string;
}
/** 文件配置项 */
declare interface FileConfig {
/** 配置项ID */
ConfigId?: string | null;
/** 配置项名称 */
ConfigName?: string | null;
/** 配置项版本 */
ConfigVersion?: string | null;
/** 配置项版本描述 */
ConfigVersionDesc?: string | null;
/** 配置项文件名 */
ConfigFileName?: string | null;
/** 配置项文件内容 */
ConfigFileValue?: string | null;
/** 配置项文件编码 */
ConfigFileCode?: string | null;
/** 创建时间 */
CreationTime?: string | null;
/** 配置项归属应用ID */
ApplicationId?: string | null;
/** 应用名称 */
ApplicationName?: string | null;
/** 删除标识 */
DeleteFlag?: boolean | null;
/** 配置项版本数量 */
ConfigVersionCount?: number | null;
/** 配置项最后更新时间 */
LastUpdateTime?: string | null;
/** 发布路径 */
ConfigFilePath?: string | null;
/** 后置命令 */
ConfigPostCmd?: string | null;
/** 配置项文件长度 */
ConfigFileValueLength?: number | null;
}
/** 文件配置项发布信息 */
declare interface FileConfigRelease {
/** 配置项发布ID */
ConfigReleaseId?: string | null;
/** 配置项ID */
ConfigId?: string | null;
/** 配置项名称 */
ConfigName?: string | null;
/** 配置项版本 */
ConfigVersion?: string | null;
/** 发布描述 */
ReleaseDesc?: string | null;
/** 发布时间。格式为 YYYY-MM-DD hh:mm:ss。 */
ReleaseTime?: string | null;
/** 部署组ID */
GroupId?: string | null;
/** 部署组名称 */
GroupName?: string | null;
/** 命名空间ID */
NamespaceId?: string | null;
/** 命名空间名称 */
NamespaceName?: string | null;
/** 集群ID */
ClusterId?: string | null;
/** 集群名称 */
ClusterName?: string | null;
/** 配置中心发布详情 */
ConfigCenters?: TsfConfigCenter[] | null;
}
/** 用于请求参数中的条件过滤字段 */
declare interface Filter {
/** 过滤条件名 */
Name: string;
/** 过滤条件匹配值,几个条件间是或关系 */
Values: string[];
}
/** 强制调度配置 */
declare interface ForceSchedule {
/** - */
AffinityList?: Affinity[];
/** - */
AntiAffinityList?: Affinity[];
}
/** 网关分组简单信息 */
declare interface GatewayApiGroupVo {
/** 分组ID */
GroupId?: string;
/** 分组名称 */
GroupName?: string;
/** 分组下API个数 */
GroupApiCount?: number;
/** 分组API列表 */
GroupApis?: GatewayGroupApiVo[];
/** 网关实例的类型 */
GatewayInstanceType?: string;
/** 网关实例ID */
GatewayInstanceId?: string;
}
/** TSF Envoy网关服务配置 */
declare interface GatewayConfig {
/** 服务名称 */
Name: string;
}
/** api分组已绑定的网关部署组 */
declare interface GatewayDeployGroup {
/** 网关部署组ID */
DeployGroupId?: string | null;
/** 网关部署组名称 */
DeployGroupName?: string | null;
/** 应用ID */
ApplicationId?: string | null;
/** 应用名称 */
ApplicationName?: string | null;
/** 应用分类:V:虚拟机应用,C:容器应用 */
ApplicationType?: string | null;
/** 部署组应用状态,取值: Running、Waiting、Paused、Updating、RollingBack、Abnormal、Unknown */
GroupStatus?: string | null;
/** 集群类型,C :容器,V:虚拟机 */
ClusterType?: string | null;
}
/** 网关API简单信息 */
declare interface GatewayGroupApiVo {
/** API ID */
ApiId?: string;
/** API 请求路径 */
Path?: string;
/** API 微服务名称 */
MicroserviceName?: string;
/** API 请求方法 */
Method?: string | null;
/** 命名空间名称 */
NamespaceName?: string | null;
}
/** 网关部署组ID和网关API分组ID元组 */
declare interface GatewayGroupIds {
/** 网关部署组ID */
GatewayDeployGroupId: string;
/** 分组id */
GroupId: string;
}
/** 微服务网关插件实例对象 */
declare interface GatewayPlugin {
/** 网关插件id */
Id?: string | null;
/** 插件名称 */
Name?: string | null;
/** 插件类型 */
Type?: string | null;
/** 插件描述 */
Description?: string | null;
/** 创建时间 */
CreatedTime?: string | null;
/** 更新时间 */
UpdatedTime?: string | null;
/** 发布状态 */
Status?: string | null;
/** 是否禁用删除 */
DeleteDisabled?: boolean;
/** 禁用原因 */
DeleteDisabledReason?: string;
}
/** 微服务网关插件绑定对象 */
declare interface GatewayPluginBoundParam {
/** 插件id */
PluginId: string;
/** 插件绑定到的对象类型:group/api/all */
ScopeType: string;
/** 插件绑定到的对象主键值,例如分组的ID/API的ID */
ScopeValue: string;
/** 创建关联的服务id,关联envoy网关时使用 */
MicroserviceId?: string;
/** 网关id */
GatewayInstanceId?: string;
}
/** 网关部署组、分组、API列表数据 */
declare interface GatewayVo {
/** 网关部署组ID */
GatewayDeployGroupId?: string;
/** 网关部署组名称 */
GatewayDeployGroupName?: string;
/** API 分组个数 */
GroupNum?: number;
/** API 分组列表 */
Groups?: GatewayApiGroupVo[];
}
/** API监控明细数据 */
declare interface GroupApiUseStatistics {
/** 总调用数 */
TopStatusCode?: ApiUseStatisticsEntity[];
/** 平均错误率 */
TopTimeCost?: ApiUseStatisticsEntity[];
/** 分位值对象 */
Quantile?: QuantileEntity;
}
/** 部署组容器信息 */
declare interface GroupContainerInfo {
/** 镜像版本名称 */
TagName: string;
/** 容器名字 */
ContainerName?: string;
/** 镜像名 */
RepoName?: string;
/** 仓库类型,tcr,address,personal,默认personal */
RepoType?: string;
/** tcr仓库信息 */
TcrRepoInfo?: TcrRepoInfo;
/** 镜像server */
Server?: string;
/** 凭证名字 */
SecretName?: string;
/** jvm 参数 */
JvmOpts?: string;
/** 容器最大的 CPU 核数,对应 K8S 的 limit */
CpuLimit?: string;
/** 容器分配的 CPU 核数,对应 K8S 的 request */
CpuRequest?: string;
/** 容器分配的内存 MiB 数,对应 K8S 的 request */
MemRequest?: string;
/** 容器最大的内存 MiB 数,对应 K8S 的 limit */
MemLimit?: string;
/** 健康检查配置信息 */
HealthCheckSettings?: HealthCheckSettings;
/** 环境变量 */
Envs?: Env[];
/** 环境变量,作为入参时不用填 */
UserEnvs?: Env[];
/** 数据卷挂载点信息 */
VolumeMountInfoList?: VolumeMountInfo[];
}
/** 分组日使用统计对象 */
declare interface GroupDailyUseStatistics {
/** 总调用数 */
TopReqAmount: GroupUseStatisticsEntity[];
/** 平均错误率 */
TopFailureRate: GroupUseStatisticsEntity[];
/** 平均响应耗时 */
TopAvgTimeCost: GroupUseStatisticsEntity[];
}
/** 日志投递kafka用,描述部署组信息 */
declare interface GroupInfo {
/** 部署组ID可通过调用[DescribeContainerGroups](https://cloud.tencent.com/document/product/649/36068)或[DescribeGroups](https://cloud.tencent.com/document/product/649/36065)查询已创建的部署组列表或登录[控制台](https://console.cloud.tencent.com/tsf/app-detail?rid=1&id=application-yo7kp9dv&tab=publish&subTab=group)进行查看。 */
GroupId: string;
/** 部署组名称 */
GroupName: string;
/** 集群类型,C:容器集群,V:虚拟机集群 */
ClusterType: string;
/** 集群ID可通过[DescribeClusters](https://cloud.tencent.com/document/product/649/85857)查询已经创建的集群列表,也可以通过登录[控制台](https://console.cloud.tencent.com/tsf/resource?rid=1)查看。 */
ClusterId?: string;
/** 集群名称 */
ClusterName?: string;
/** 命名空间名称 */
NamespaceName?: string;
/** 绑定时间,格式yyyy-MM-dd HH:mm:ss */
AssociateTime?: string;
}
/** 部署组实例列表 */
declare interface GroupPod {
/** 实例名称(对应到kubernetes的pod名称) */
PodName?: string;
/** 实例ID(对应到kubernetes的pod id) */
PodId?: string;
/** 实例状态,请参考后面的实例以及容器的状态定义。启动中(pod 未 ready):Starting;运行中:Running;异常:Abnormal;停止:Stopped; */
Status?: string;
/** 实例处于当前状态的原因,例如容器下载镜像失败 */
Reason?: string;
/** 主机IP */
NodeIp?: string;
/** 实例IP */
Ip?: string;
/** 实例中容器的重启次数 */
RestartCount?: number;
/** 实例中已就绪容器的个数 */
ReadyCount?: number;
/** 运行时长,单位秒 */
Runtime?: string;
/** 实例启动时的时间戳,单位秒 */
CreatedAt?: string;
/** 服务实例状态,枚举值为:- `Starting`:启动中- `Running`:运行中- `Stopping`:停止中- `Stopped`: 已停止- `StopFailed`: 停止失败- `Abnormal`: 异常- `Unknown`: 未知 */
ServiceInstanceStatus?: string;
/** 机器实例可使用状态,枚举值为:- `Starting`:启动中- `Running`:运行中- `Stopping`:停止中- `Stopped`: 已停止- `StopFailed`: 停止失败- `Abnormal`: 异常- `Unknown`: 未知 */
InstanceAvailableStatus?: string;
/** 机器实例状态 */
InstanceStatus?: string;
/** 节点实例id */
NodeInstanceId?: string;
/** 预期副本数 */
SpecTotalCount?: string;
}
/** 部署组实例列表 */
declare interface GroupPodResult {
/** 总记录数 */
TotalCount?: number;
/** 列表信息 */
Content?: GroupPod[];
}
/** 部署组配置发布相关信息 */
declare interface GroupRelease {
/** 程序包ID */
PackageId?: string | null;
/** 程序包名 */
PackageName?: string | null;
/** 程序包版本 */
PackageVersion?: string | null;
/** 镜像名 */
RepoName?: string | null;
/** 镜像版本 */
TagName?: string | null;
/** 已发布的全局配置列表 */
PublicConfigReleaseList?: ConfigRelease[] | null;
/** 已发布的应用配置列表 */
ConfigReleaseList?: ConfigRelease[] | null;
/** 已发布的文件配置列表 */
FileConfigReleaseList?: FileConfigRelease[] | null;
}
/** 部署组相关的参数配置 */
declare interface GroupResourceConfig {
/** 容器部署组相关的参数配置 */
Container: ContainerGroupResourceConfig | null;
}
/** 单元化API使用详情统计对象列表 */
declare interface GroupUnitApiDailyUseStatistics {
/** 命名空间ID */
NamespaceId: string;
/** 命名空间名称 */
NamespaceName: string;
/** 该API在该命名空间下的总调用次数 */
SumReqAmount: string;
/** 该API在该命名空间下的平均错误率 */
AvgFailureRate: string;
/** 该API在该命名空间下的平均响应时间 */
AvgTimeCost: string;
/** 监控数据曲线点位图Map集合 */
MetricDataPointMap: MetricDataPointMap;
/** 状态码分布详情 */
TopStatusCode: ApiUseStatisticsEntity[];
/** 耗时分布详情 */
TopTimeCost: ApiUseStatisticsEntity[];
/** 分位值对象 */
Quantile: QuantileEntity;
}
/** 查询网关API监控明细数据(单元化网关使用详情) */
declare interface GroupUnitApiUseStatistics {
/** 总记录数 */
TotalCount: number;
/** 查询网关API监控明细对象集合 */
Content: GroupUnitApiDailyUseStatistics[];
}
/** API分组日使用统计对象数据点 */
declare interface GroupUseStatisticsEntity {
/** API 路径 */
ApiPath?: string;
/** 服务名 */
ServiceName?: string;
/** 统计值 */
Value?: string;
/** API ID */
ApiId?: string;
}
/** 健康检查配置 */
declare interface HealthCheckConfig {
/** 健康检查路径 */
Path?: string;
}
/** 健康检查配置信息,若不指定该参数,则默认不设置健康检查。 */
declare interface HealthCheckSetting {
/** 健康检查方法。HTTP:通过 HTTP 接口检查;CMD:通过执行命令检查;TCP:通过建立 TCP 连接检查。 */
ActionType: string | null;
/** 容器延时启动健康检查的时间,单位秒。 */
InitialDelaySeconds?: number | null;
/** 每次健康检查响应的最大超时时间,单位秒。 */
TimeoutSeconds?: number | null;
/** 进行健康检查的时间间隔,单位秒。 */
PeriodSeconds?: number | null;
/** 表示后端容器从失败到成功的连续健康检查成功次数。 */
SuccessThreshold?: number | null;
/** 表示后端容器从成功到失败的连续健康检查成功次数。 */
FailureThreshold?: number | null;
/** HTTP 健康检查方法使用的检查协议。支持HTTP、HTTPS。 */
Scheme?: string | null;
/** 健康检查端口,范围 1~65535 。 */
Port?: number | null;
/** HTTP 健康检查接口的请求路径。 */
Path?: string | null;
/** 执行命令检查方式,执行的命令。 */
Command?: string[] | null;
/** TSF_DEFAULT:tsf 默认就绪探针。K8S_NATIVE:k8s 原生探针。不填默认为 k8s 原生探针。 */
Type?: string | null;
}
/** 健康检查参数 */
declare interface HealthCheckSettings {
/** 存活健康检查 */
LivenessProbe?: HealthCheckSetting | null;
/** 就绪健康检查 */
ReadinessProbe?: HealthCheckSetting | null;
}
/** HttpGet 执行内容 */
declare interface HttpGetOption {
/** 主机地址 */
Host?: string | null;
/** 路径 */
Path?: string | null;
/** 端口 */
Port?: string | null;
/** 协议:HTTP|HTTPS */
Scheme?: string | null;
}
/** 镜像仓库 */
declare interface ImageRepository {
/** 仓库名,含命名空间,如tsf/nginx */
Reponame?: string;
/** 仓库类型 */
Repotype?: string;
/** 镜像版本数 */
TagCount?: number;
/** 是否公共,1:公有,0:私有 */
IsPublic?: number;
/** 是否被用户收藏。true:是,false:否 */
IsUserFavor?: boolean;
/** 是否是腾讯云官方仓库。 是否是腾讯云官方仓库。true:是,false:否 */
IsQcloudOfficial?: boolean;
/** 被所有用户收藏次数 */
FavorCount?: number;
/** 拉取次数 */
PullCount?: number;
/** 描述内容 */
Description?: string;
/** 创建时间 */
CreationTime?: string;
/** 更新时间 */
UpdateTime?: string;
/** TcrRepoInfo值 */
TcrRepoInfo?: TcrRepoInfo;
/** TcrBindingId值 */
TcrBindingId?: number;
/** applicationid值 */
ApplicationId?: string;
/** ApplicationName值(废弃) */
ApplicationName?: ScalableRule;
/** ApplicationName值 */
ApplicationNameReal?: string;
/** 是否公共,1:公有,0:私有 */
Public?: number;
/** 创建方式:manual | automatic */
CreateMode?: string;
/** 仓库名,等同reponame字段 */
RepoName?: string;
/** 仓库类型 */
RepoType?: string;
}
/** 镜像仓库列表 */
declare interface ImageRepositoryResult {
/** 总记录数 */
TotalCount?: number;
/** 镜像服务器地址 */
Server?: string | null;
/** 列表信息 */
Content?: ImageRepository[];
}
/** 列表信息 */
declare interface ImageTag {
/** 仓库名 */
RepoName?: string;
/** 版本名称 */
TagName?: string;
/** 版本ID */
TagId?: string;
/** 镜像ID */
ImageId?: string;
/** 大小 */
Size?: string;
/** 创建时间 */
CreationTime?: string;
/** 更新时间 */
UpdateTime?: string;
/** 镜像制作者 */
Author?: string;
/** CPU架构 */
Architecture?: string;
/** Docker客户端版本 */
DockerVersion?: string;
/** 操作系统 */
Os?: string;
/** push时间 */
PushTime?: string;
/** 单位为字节 */
SizeByte?: number;
/** TcrRepoInfo值 */
TcrRepoInfo?: TcrRepoInfo;
}
/** 镜像版本列表 */
declare interface ImageTagsResult {
/** 总记录数 */
TotalCount?: number;
/** 仓库名,含命名空间,如tsf/ngin */
RepoName?: string;
/** 镜像服务器地址 */
Server?: string;
/** 列表信息 */
Content?: ImageTag[];
}
/** 监控指标坐标 */
declare interface IndicatorCoord {
/** 指标横坐标值 */
CoordX?: string;
/** 指标纵坐标值 */
CoordY?: string;
/** 指标标签,用于标识附加信息 */
CoordTag?: string;
}
/** 机器实例 */
declare interface Instance {
/** 机器实例ID */
InstanceId?: string | null;
/** 机器名称 */
InstanceName?: string | null;
/** 机器内网地址IP */
LanIp?: string | null;
/** 机器外网地址IP */
WanIp?: string | null;
/** 机器描述信息 */
InstanceDesc?: string | null;
/** 集群ID */
ClusterId?: string | null;
/** 集群名称 */
ClusterName?: string | null;
/** VM的状态 虚机:虚机的状态 容器:Pod所在虚机的状态 */
InstanceStatus?: string | null;
/** VM的可使用状态 虚机:虚机是否能够作为资源使用 容器:虚机是否能够作为资源部署POD */
InstanceAvailableStatus?: string | null;
/** 服务下的服务实例的状态 虚机:应用是否可用 + Agent状态 容器:Pod状态 */
ServiceInstanceStatus?: string | null;
/** 标识此instance是否已添加在tsf中 */
CountInTsf?: number | null;
/** 机器所属部署组ID */
GroupId?: string | null;
/** 机器所属应用ID */
ApplicationId?: string | null;
/** 机器所属应用名称 */
ApplicationName?: string | null;
/** 机器实例在CVM的创建时间 */
InstanceCreatedTime?: string | null;
/** 机器实例在CVM的过期时间 */
InstanceExpiredTime?: string | null;
/** 机器实例在CVM的计费模式 */
InstanceChargeType?: string | null;
/** 机器实例总CPU信息 */
InstanceTotalCpu?: number | null;
/** 机器实例总内存信息 */
InstanceTotalMem?: number | null;
/** 机器实例使用的CPU信息 */
InstanceUsedCpu?: number | null;
/** 机器实例使用的内存信息 */
InstanceUsedMem?: number | null;
/** 机器实例Limit CPU信息 */
InstanceLimitCpu?: number | null;
/** 机器实例Limit 内存信息 */
InstanceLimitMem?: number | null;
/** 包版本 */
InstancePkgVersion?: string | null;
/** 集群类型 */
ClusterType?: string | null;
/** 机器实例业务状态 */
RestrictState?: string | null;
/** 更新时间 */
UpdateTime?: string | null;
/** 实例执行状态 */
OperationState?: number | null;
/** NamespaceId Ns ID */
NamespaceId?: string | null;
/** InstanceZoneId 可用区ID */
InstanceZoneId?: string | null;
/** InstanceImportMode 导入模式 */
InstanceImportMode?: string | null;
/** ApplicationType应用类型 */
ApplicationType?: string | null;
/** ApplicationResourceType 资源类型 */
ApplicationResourceType?: string | null;
/** sidecar状态 */
ServiceSidecarStatus?: string | null;
/** 部署组名 */
GroupName?: string | null;
/** NS名 */
NamespaceName?: string | null;
/** 健康检查原因 */
Reason?: string | null;
/** agent版本 */
AgentVersion?: string | null;
/** 容器母机实例ID */
NodeInstanceId?: string | null;
}
/** 容器导入实例高级设置 */
declare interface InstanceAdvancedSettings {
/** 数据盘挂载点, 默认不挂载数据盘. 已格式化的 ext3,ext4,xfs 文件系统的数据盘将直接挂载,其他文件系统或未格式化的数据盘将自动格式化为ext4 并挂载,请注意备份数据! 无数据盘或有多块数据盘的云主机此设置不生效。注意,注意,多盘场景请使用下方的DataDisks数据结构,设置对应的云盘类型、云盘大小、挂载路径、是否格式化等信息。 */
MountTarget: string;
/** dockerd --graph 指定值, 默认为 /var/lib/docker */
DockerGraphPath: string;
}
/** 包含虚拟机所在TSF中的位置信息 */
declare interface InstanceEnrichedInfo {
/** 机器ID */
InstanceId?: string;
/** 机器名称 */
InstanceName?: string;
/** 机器内网IP */
LanIp?: string;
/** 机器外网IP */
WanIp?: string;
/** 机器所在VPC */
VpcId?: string;
/** 机器运行状态,枚举值为:- `Pending`: 准备中- `Running`: 运行中- `Stopped`: 已停止- `Rebooting`: 重启中- `Starting`: 启动中- `Stopping`: 停止中- `Abnormal`: 异常- `Unknown`: 未知- `Offline`: 离线 */
InstanceStatus?: string;
/** 机器可用状态(表示机器上的Agent在线) */
InstanceAvailableStatus?: string;
/** 应用ID */
ApplicationId?: string;
/** 应用名称 */
ApplicationName?: string;
/** 应用类型,C表示容器应用,V表示虚拟机应用 */
ApplicationType?: string;
/** 集群ID */
ClusterId?: string;
/** 集群名称 */
ClusterName?: string;
/** 集群类型,C表示容器集群,V表示虚拟机集群 */
ClusterType?: string;
/** 命名空间ID */
NamespaceId?: string;
/** 命名空间名称 */
NamespaceName?: string;
/** 机器所在部署组ID */
GroupId?: string;
/** 部署组名称 */
GroupName?: string;
}
/** InstanceEnrichedInfo列表结构 */
declare interface InstanceEnrichedInfoPage {
/** 总数量 */
TotalCount?: number;
/** 列表 */
Content?: InstanceEnrichedInfo[];
}
/** 实例相关的参数配置 */
declare interface InstanceResourceConfig {
/** 容器实例相关的参数配置 */
Container: ContainerInstanceResourceConfig | null;
/** 虚拟机实例相关的参数配置 */
Vm: VmInstanceResourceConfig | null;
}
/** 服务调用监控指标 */
declare interface InvocationIndicator {
/** 总请求数 */
InvocationQuantity?: number | null;
/** 请求成功率,百分比 */
InvocationSuccessRate?: number | null;
/** 请求平均耗时,单位毫秒 */
InvocationAvgDuration?: number | null;
/** 成功请求数时间分布 */
InvocationSuccessDistribution?: IndicatorCoord[];
/** 失败请求数时间分布 */
InvocationFailedDistribution?: IndicatorCoord[];
/** 状态码分布 */
InvocationStatusDistribution?: IndicatorCoord[];
/** 时延分布 */
InvocationDurationDistribution?: IndicatorCoord[];
/** 并发请求次数时间分布 */
InvocationQuantityDistribution?: IndicatorCoord[];
}
/** 监控数据散点图 */
declare interface InvocationMetricScatterPlot {
/** 时间轴截止时间,GMT,精确到毫秒 */
EndTime?: number;
/** 时间粒度 */
StartTime?: number;
/** 时间轴开始时间,GMT,精确到毫秒 */
Period?: number;
/** 多值数据点集合 */
DataPoints?: MultiValueDataPoints[];
}
/** DescribeJvmMonitor查询jvm监控数据接口返回数据封装 */
declare interface JvmMonitorData {
/** 堆内存监控图,三条线 */
HeapMemory?: MemoryPicture | null;
/** 非堆内存监控图,三条线 */
NonHeapMemory?: MemoryPicture | null;
/** 伊甸园区监控图,三条线 */
EdenSpace?: MemoryPicture | null;
/** 幸存者区监控图,三条线 */
SurvivorSpace?: MemoryPicture | null;
/** 老年代监控图,三条线 */
OldSpace?: MemoryPicture | null;
/** 元空间监控图,三条线 */
MetaSpace?: MemoryPicture | null;
/** 线程监控图,三条线 */
ThreadPicture?: ThreadPicture | null;
/** youngGC增量监控图,一条线 */
YoungGC?: CurvePoint[] | null;
/** fullGC增量监控图,一条线 */
FullGC?: CurvePoint[] | null;
/** cpu使用率,一条线 */
CpuUsage?: CurvePoint[] | null;
/** 加载类数,一条线 */
ClassCount?: CurvePoint[] | null;
}
/** 投递kafka配置项 */
declare interface KafkaDeliveryConfig {
/** 配置项id */
ConfigId?: string;
/** 配置名称 */
ConfigName?: string;
/** 采集路径 */
CollectPath?: string[];
/** kafka vip */
KafkaVIp?: string;
/** kafka vport */
KafkaVPort?: string | null;
/** kafka topic */
Topic?: string;
/** 换行规则 */
LineRule?: string;
/** 是否需要认证 */
EnableAuth?: boolean;
/** 用户名 */
Username?: string | null;
/** 密码 */
Password?: string | null;
/** 投递的to