数据结构

Autoscaler

弹性伸缩策略组合

被如下接口引用：CreateApplicationAutoscaler, DescribeApplicationAutoscalerList, DescribeApplicationInfo, ModifyApplicationAutoscaler。

名称	类型	必选	描述
MinReplicas	Integer	是	弹性伸缩最小实例数 示例值：0
MaxReplicas	Integer	是	弹性伸缩最大实例数 示例值：2
HorizontalAutoscaler	Array of HorizontalAutoscaler	否	指标弹性伸缩策略(指标策略和定时策略必须填写一个) 示例值：{"HorizontalAutoscaler":[{"DoubleThreshold":50,"Enabled":true,"MaxReplicas":4,"Metrics":"CPU","MinReplicas":0}]}
CronHorizontalAutoscaler	Array of CronHorizontalAutoscaler	否	定时弹性伸缩策略(指标策略和定时策略必须填写一个) 示例值：{"CronHorizontalAutoscaler":[{"Enabled":false,"Name":"pk-test","Period":"* * *","Priority":0,"Schedules":[{"StartAt":"02:00","TargetReplicas":1}]}]}
AutoscalerId	String	否	弹性伸缩ID 示例值：scaler-xxxxxx
AutoscalerName	String	否	弹性伸缩名称 示例值：scaler-name
Description	String	否	弹性伸缩描述 示例值：这是一个描述
CreateDate	String	否	创建日期 示例值：2024-10-25 16:36:10
ModifyDate	String	否	修改时间 示例值：2024-10-25 16:36:10
EnableDate	String	否	启用时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-10-25 16:36:10
Enabled	Boolean	否	是否启用 示例值：true

ConfigData

配置

被如下接口引用：DescribeConfigData, DescribeConfigDataList。

名称	类型	描述
Name	String	配置名称 示例值：name-xxx
CreateTime	String	创建时间 示例值：2012-12-10 09:00:00
RelatedApplications	Array of TemService	关联的服务列表
Data	Array of Pair	配置条目

CosToken

Cos token

被如下接口引用：CreateCosToken。

名称	类型	描述
RequestId	String	唯一请求 ID 示例值：1
Bucket	String	存储桶桶名 示例值：1
Region	String	存储桶所在区域 示例值：1
TmpSecretId	String	临时密钥的SecretId 示例值：1
TmpSecretKey	String	临时密钥的SecretKey 示例值：1
SessionToken	String	临时密钥的 sessionToken 示例值：1
StartTime	String	临时密钥获取的开始时间 示例值：1
ExpiredTime	String	临时密钥的 expiredTime 示例值：1
FullPath	String	包完整路径 示例值：1

CronHorizontalAutoscaler

定时伸缩策略

被如下接口引用：CreateApplicationAutoscaler, DeployApplication, DescribeApplicationAutoscalerList, DescribeApplicationInfo, ModifyApplicationAutoscaler。

名称	类型	必选	描述
Name	String	否	定时伸缩策略名称 示例值：1
Period	String	否	策略周期 * * ，三个范围，第一个是天，第二个是月，第三个是周，中间用空格隔开 例子： * * （每天） * * 0-3 （每周日到周三） 1,11,21 * （每个月1号，11号，21号） 示例值： * *
Schedules	Array of CronHorizontalAutoscalerSchedule	否	定时伸缩策略明细 示例值：1
Enabled	Boolean	否	是否启用 示例值：1
Priority	Integer	否	策略优先级，值越大优先级越高，0为最小值 示例值：1

CronHorizontalAutoscalerSchedule

定时伸缩策略明细

被如下接口引用：CreateApplicationAutoscaler, DeployApplication, DescribeApplicationAutoscalerList, DescribeApplicationInfo, ModifyApplicationAutoscaler。

名称	类型	必选	描述
StartAt	String	是	触发事件，小时分钟，用:分割 例如 00:00（零点零分触发） 示例值：00:00
TargetReplicas	Integer	否	目标实例数（不大于50） 示例值：1

DeployServiceBatchDetail

分批发布单批次详情

被如下接口引用：DescribeDeployApplicationDetail。

名称	类型	必选	描述
OldPodList	DeployServicePodDetail	否	旧实例列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：[1]
NewPodList	DeployServicePodDetail	否	新实例列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：[1]
BatchStatus	String	否	当前批次状态："WaitForTimeExceed", "WaitForResume", "Deploying", "Finish", "NotStart" 示例值：Finish
PodNum	Integer	否	该批次预计旧实例数量 示例值：3
BatchIndex	Integer	否	批次id 示例值：0
OldPods	Array of DeployServicePodDetail	否	旧实例列表 示例值：[1]
NewPods	Array of DeployServicePodDetail	否	新实例列表 示例值：[1]
NextBatchStartTime	Integer	否	=0：手动确认批次；>0：下一批次开始时间戳 示例值：0

DeployServicePodDetail

分批发布单批次详情

被如下接口引用：DescribeDeployApplicationDetail。

名称	类型	必选	描述
PodId	String	否	pod Id 示例值：pod-123
PodStatus	Array of String	否	pod状态 示例值：Pending
PodVersion	String	否	pod版本 示例值：v1.1
CreateTime	String	否	pod创建时间 示例值：2020-01-01 11：11：11
Zone	String	否	pod所在可用区 示例值：shanghai-zone-4
Webshell	String	否	webshell地址 示例值：webshell
Status	String	否	状态 示例值：1

DeployStrategyConf

分批发布策略配置

被如下接口引用：DeployApplication, DescribeApplicationInfo, DescribeDeployApplicationDetail。

名称	类型	必选	描述
TotalBatchCount	Integer	否	总分批数 示例值：10
BetaBatchNum	Integer	否	beta分批实例数 示例值：5
DeployStrategyType	Integer	否	分批策略：0-全自动，1-全手动，2-beta分批，beta批一定是手动的，3-首次发布 示例值：1
BatchInterval	Integer	否	每批暂停间隔 示例值：200
MinAvailable	Integer	否	最小可用实例数 示例值：1
Force	Boolean	否	是否强制发布 示例值：false

DescribeConfigDataListPage

配置信息的分页列表

被如下接口引用：DescribeConfigDataList。

名称	类型	描述
Records	Array of ConfigData	记录
ContinueToken	String	分页游标，用以查询下一页 示例值：token-xxx
RemainingCount	Integer	剩余数目 注意：此字段可能返回 null，表示取不到有效值。 示例值：22

DescribeRunPodPage

版本pod列表

被如下接口引用：DescribeApplicationInfo, DescribeApplicationPods, DescribeApplicationsStatus, DescribeDeployApplicationDetail。

名称	类型	必选	描述
Offset	Integer	否	分页下标 示例值：0
Limit	Integer	否	单页条数 示例值：10
TotalCount	Integer	否	总数 示例值：1
RequestId	String	否	请求id 示例值：1ce4bb30-202a-403a-8552-1a38b21xxxx
PodList	Array of RunVersionPod	否	条目 示例值：[{"ApplicationName":"app0925","Webshell":"https://tkecache.cloud.tencent.com/xxxxxx","PodId":"app0925-xxxxxx"}]

EksService

eks service info

被如下接口引用：DeployApplication, DescribeApplicationInfo, DescribeApplicationServiceList, ModifyApplicationService。

名称	类型	必选	描述
Name	String	否	service name 示例值：name-xxx
Ports	Array of Integer	否	可用端口 示例值：[8080]
Yaml	String	否	yaml 内容 示例值：apiVersion: v1-xxxxxx
ApplicationName	String	否	服务名 示例值：app-name-xxx
VersionName	String	否	版本名 示例值：version-xxxx
ClusterIp	Array of String	否	内网ip 示例值：172.xx.xx.xx
ExternalIp	String	否	外网ip 示例值：10.xx.xx.xx
Type	String	否	访问类型，可选值： - EXTERNAL（公网访问） - VPC（vpc内访问） - CLUSTER（集群内访问） 示例值：VPC
SubnetId	String	否	子网ID，只在类型为vpc访问时才有值 示例值：subnet-xxxxxx
LoadBalanceId	String	否	负载均衡ID，只在外网访问和vpc内访问才有值，默认自动创建 示例值：10.xx.xx.xx
PortMappings	Array of PortMapping	否	端口映射
ServicePortMappingList	Array of ServicePortMapping	否	每种类型访问配置详情
FlushAll	Boolean	否	刷新复写所有类型 示例值：true
EnableRegistryNextDeploy	Integer	否	1: 下次部署自动注入注册中心信息；0：不注入 注意：此字段可能返回 null，表示取不到有效值。 示例值：0
ApplicationId	String	否	返回应用id 示例值：app-xxxxxx
AllIpDone	Boolean	否	所有服务IP是否已经ready 示例值：false
ExternalDomain	String	否	clb 域名 示例值：lb-xxxx.com

EnablePrometheusConf

开启prometheus监控配置

被如下接口引用：DeployApplication, DescribeApplicationInfo。

名称	类型	必选	描述
Port	Integer	否	应用开放的监听端口 示例值：9090
Path	String	否	业务指标暴露的url path 示例值：/metrics

EsInfo

弹性伸缩配置

被如下接口引用：DeployApplication, DescribeApplicationInfo。

名称	类型	必选	描述
MinAliveInstances	Integer	是	最小实例数 示例值：1
MaxAliveInstances	Integer	是	最大实例数 示例值：5
EsStrategy	Integer	是	弹性策略,1:cpu，2:内存 示例值：1
Threshold	Integer	是	弹性扩缩容条件值 示例值：50
VersionId	String	否	版本Id 示例值：version-test

HealthCheckConfig

健康检查配置

被如下接口引用：DeployApplication, DescribeApplicationInfo。

名称	类型	必选	描述
Type	String	是	支持的健康检查类型，如 HttpGet，TcpSocket，Exec 示例值：HttpGet
Protocol	String	否	仅当健康检查类型为 HttpGet 时有效，表示协议类型，如 HTTP，HTTPS 示例值：HTTP
Path	String	否	仅当健康检查类型为 HttpGet 时有效，表示请求路径 示例值：/xxx
Exec	String	否	仅当健康检查类型为 Exec 时有效，表示执行的脚本内容 示例值：shell cmd
Port	Integer	否	仅当健康检查类型为 HttpGet\TcpSocket 时有效，表示请求路径 示例值：80
InitialDelaySeconds	Integer	否	检查延迟开始时间，单位为秒，默认为 0 示例值：0
TimeoutSeconds	Integer	否	超时时间，单位为秒，默认为 1 示例值：1
PeriodSeconds	Integer	否	间隔时间，单位为秒，默认为 10 示例值：10

HorizontalAutoscaler

弹性伸缩策略

被如下接口引用：CreateApplicationAutoscaler, DeployApplication, DescribeApplicationAutoscalerList, DescribeApplicationInfo, ModifyApplicationAutoscaler。

名称	类型	必选	描述
MinReplicas	Integer	否	最小实例数（可以不传） 示例值：1
MaxReplicas	Integer	否	最大实例数（可以不传） 示例值：1
Metrics	String	否	指标度量 CPU（CPU使用率，%） MEMORY（内存使用率，%） CPU_CORE_USED（CPU使用量，core） MEMORY_SIZE_USED(内存使用量，MiB) NETWORK_BANDWIDTH_RECEIVE(网络入带宽，MBps) NETWORK_BANDWIDTH_TRANSMIT(网络出带宽，MBps) NETWORK_TRAFFIC_RECEIVE(网络入流量，MiB/s) NETWORK_TRAFFIC_TRANSMIT(网络出流量，MiB/s) NETWORK_PACKETS_RECEIVE(网络入包量，Count/s) NETWORK_PACKETS_TRANSMIT(网络出包量，Count/s) FS_IOPS_WRITE(磁盘写次数，Count/s) FS_IOPS_READ(磁盘读次数，Count/s) FS_SIZE_WRITE(磁盘写大小，MiB/s) FS_SIZE_READ(磁盘读大小，MiB/s) 示例值：1
Threshold	Integer	否	阈值（整数） 示例值：1
Enabled	Boolean	否	是否启用 示例值：1
DoubleThreshold	Float	否	阈值（小数，优先使用） 示例值：1

IngressInfo

Ingress 配置

被如下接口引用：DescribeIngress, DescribeIngresses, DescribeRelatedIngresses, ModifyIngress。

名称	类型	必选	描述
EnvironmentId	String	是	环境ID 示例值：en-xxxxxx
AddressIPVersion	String	是	ip version 示例值：IPV4
IngressName	String	是	ingress name 示例值：ingress name
Rules	Array of IngressRule	是	rules 配置 示例值：rules 配置
ClbId	String	是	clb ID 示例值：clb-xxx
ClusterNamespace	String	否	环境namespace 示例值：default
Tls	Array of IngressTls	否	tls 配置 注意：此字段可能返回 null，表示取不到有效值。 示例值：tls 配置
ClusterId	String	否	环境集群ID 示例值：cls-xxx
Vip	String	否	clb ip 示例值：10.10.10.10
CreateTime	String	否	创建时间 示例值：2010-11-11 22:21:11
Mixed	Boolean	否	是否混合 https，默认 false，可选值 true 代表有 https 协议监听 示例值：false
RewriteType	String	否	重定向模式，可选值： - AUTO（自动重定向http到https） - NONE（不使用重定向） 示例值：1
Domain	String	否	clb 域名 示例值：lb-xxx

IngressRule

ingress rule 配置

被如下接口引用：DescribeIngress, DescribeIngresses, DescribeRelatedIngresses, ModifyGatewayIngress, ModifyIngress。

名称	类型	必选	描述
Http	IngressRuleValue	是	ingress rule value 示例值：ingress rule value
Host	String	否	host 地址 示例值：xxx.com
Protocol	String	否	协议，选项为 http， https，默认为 http 示例值：protocol

IngressRuleBackend

Ingress 规则 backend 配置

被如下接口引用：ModifyGatewayIngress。

名称	类型	必选	描述
ServiceName	String	是	eks service 名 示例值：serviceA
ServicePort	Integer	是	eks service 端口 示例值：8080

IngressRulePath

Ingress Rule Path 配置

被如下接口引用：ModifyGatewayIngress。

名称	类型	必选	描述
Path	String	是	path 信息 示例值：/xxx
Backend	IngressRuleBackend	是	backend 配置 示例值：{"ServiceName": "serviceA", "ServicePort": 8080}

IngressRuleValue

Ingress Rule Value 配置

被如下接口引用：ModifyGatewayIngress。

名称	类型	必选	描述
Paths	Array of IngressRulePath	是	rule 整体配置 示例值：rulePaths 数组

IngressTls

ingress tls 配置

被如下接口引用：DescribeIngress, DescribeIngresses, DescribeRelatedIngresses, ModifyGatewayIngress, ModifyIngress。

名称	类型	必选	描述
Hosts	Array of String	是	host 数组, 空数组表示全部域名的默认证书 示例值：["xx.com", "yyy.com"]
SecretName	String	是	secret name，如使用证书，则填空字符串 示例值：secret
CertificateId	String	否	SSL Certificate Id 示例值：CertificateId

LogConfig

日志收集配置

被如下接口引用：DescribeLogConfig, DescribePagedLogConfigList, ModifyLogConfig。

名称	类型	必选	描述
Name	String	否	名称 示例值：ab-xxx
InputType	String	否	收集类型，container_stdout 为标准输出；container_file 为文件； 示例值：container_stdout
LogsetId	String	否	日志集 ID 示例值：4d43fac5-fc0a-42bf-92a9-ef5b5b245e6a
TopicId	String	否	日志主题 ID 示例值：dbebda3e-0a9a-4888-9d5c-642bf2ffa183
LogType	String	否	日志提取模式，minimalist_log 为单行全文；multiline_log 为多行全文； fullregex_log 为单行正则； multiline_fullregex_log 为多行正则； json_log 为 json； 示例值：json_log
BeginningRegex	String	否	首行正则表达式，当 LogType 为多行全文、多行正则时生效 示例值：^ERROR
LogPath	String	否	收集文件目录，当 InputType=container_file 时生效 示例值：/abc
FilePattern	String	否	收集文件名模式，当 InputType=container_file 时生效 示例值：app_*.log
CreateDate	String	否	创建时间 示例值：2022-05-20T14:42:16Z
ModifyDate	String	否	更新时间 示例值：2022-05-20T14:42:16Z
ApplicationId	String	否	应用 ID 示例值：app-xxx
ApplicationName	String	否	应用名 示例值：abc-xxx
ExtractRule	LogConfigExtractRule	否	导出规则

LogConfigExtractRule

日志采集的导出规则配置

被如下接口引用：CreateLogConfig, DescribeLogConfig, DescribePagedLogConfigList, ModifyLogConfig。

名称	类型	必选	描述
BeginningRegex	String	否	首行正则表达式 示例值：^ERROR
Keys	Array of String	否	提取结果 示例值：["k1", "k2"]
FilterKeys	Array of String	否	过滤键 示例值：["k1"]
FilterRegex	Array of String	否	过滤值 示例值：["v1*"]
LogRegex	String	否	日志正则表达式 示例值：^Info
TimeKey	String	否	时间字段 示例值：time
TimeFormat	String	否	时间格式 示例值：%Y-%m-%d %H:%M:%S
UnMatchUpload	String	否	是否上传解析失败日志 示例值：true
UnMatchedKey	String	否	解析失败日志的键名称 示例值：LogParseFailure
Backtracking	String	否	tracking 示例值：tracking-xxx
Delimiter	String	否	分隔符 示例值：:

LogConfigListPage

LogConfig 列表结果

被如下接口引用：DescribePagedLogConfigList。

名称	类型	描述
Records	Array of LogConfig	记录
ContinueToken	String	翻页游标 示例值：token-xxx

LogOutputConf

日志输出配置

被如下接口引用：DeployApplication, DescribeApplicationInfo, DescribeApplicationsStatus。

名称	类型	必选	描述
OutputType	String	是	日志消费端类型 示例值：cls、kafka
ClsLogsetName	String	否	cls日志集 示例值：1
ClsLogTopicId	String	否	cls日志主题 示例值：1
ClsLogsetId	String	否	cls日志集id 示例值：1
ClsLogTopicName	String	否	cls日志名称 示例值：1

MountedSettingConf

挂载配置信息

被如下接口引用：DeployApplication, DescribeApplicationInfo。

名称	类型	必选	描述
ConfigDataName	String	是	配置名称 示例值：1
MountedPath	String	是	挂载路径 示例值：1
Data	Array of Pair	否	配置内容
SecretDataName	String	否	加密配置名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：1

NamespaceInfo

Namespace 基础信息

被如下接口引用：DescribeEnvironment。

名称	类型	描述
EnvironmentId	String	ID 信息 示例值：env-xxx
NamespaceName	String	名字（已弃用） 示例值：name-test
Region	String	地域 示例值：ap-shanghai
VpcId	String	vpc id 示例值：vpc-k1ae4nhe
SubnetIds	Array of String	subnet id 数组 示例值：["subnet-xxx"]
Description	String	描述 示例值：这是一个描述
CreatedDate	String	创建时间 示例值：2012-08-08
EnvironmentName	String	环境名称 示例值：1
ApmInstanceId	String	APM 资源 ID 示例值：instance-xxx
Locked	Integer	环境是否上锁，1为上锁，0则未上锁 示例值：1
Tags	Array of Tag	标签 示例值：1
EnvType	String	环境类型：test、pre、prod 示例值：prod

NamespacePage

命名空间分页

被如下接口引用：DescribeEnvironments。

名称	类型	描述
Records	Array of TemNamespaceInfo	分页内容 示例值：1
Total	Integer	总数 示例值：1
Size	Integer	条目数 示例值：1
Pages	Integer	页数 示例值：1
Current	Integer	当前条目 示例值：1

NamespaceStatusInfo

命名空间状态

被如下接口引用：DescribeEnvironmentStatus。

名称	类型	必选	描述
EnvironmentId	String	是	命名空间id 示例值：1
EnvironmentName	String	是	命名空间名称 示例值：1
ClusterId	String	否	TCB envId | EKS clusterId 示例值：env-xxx | cls-xxx
ClusterStatus	String	否	环境状态 示例值：normal | unavailable
EnvironmentStartingStatus	TemEnvironmentStartingStatus	否	环境启动状态（不在启动中为null） 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
EnvironmentStoppingStatus	TemEnvironmentStoppingStatus	否	环境停止状态（不在停止中为null） 注意：此字段可能返回 null，表示取不到有效值。 示例值：1

NodeInfo

node信息

被如下接口引用：DescribeApplicationInfo, DescribeApplicationPods, DescribeApplicationsStatus。

名称	类型	必选	描述
Name	String	否	node名字 示例值：eklet-subnet-kctzw7nj-xxxxx
Zone	String	否	node可用区 示例值：ap-shanghai-1
SubnetId	String	否	node子网ID 示例值：subnet-xxxxxx
AvailableIpCount	String	否	可用IP数 示例值：128
Cidr	String	否	cidr块 示例值：10.0.10.0-24

Pair

键值对

被如下接口引用：CreateConfigData, DeployApplication, DescribeApplicationInfo, DescribeConfigData, ModifyConfigData。

名称	类型	必选	描述
Key	String	是	键 示例值：1
Value	String	是	值 示例值：1
Type	String	否	类型，default 为自定义，reserved 为系统变量，referenced 为引用配置项 示例值：default
Config	String	否	配置名称 示例值：configName
Secret	String	否	加密配置名称 示例值：1

PortMapping

服务端口映射

被如下接口引用：DeployApplication, DescribeApplicationInfo, DescribeApplicationServiceList, ModifyApplicationService。

名称	类型	必选	描述
Port	Integer	是	端口 示例值：1
TargetPort	Integer	是	映射端口 示例值：1
Protocol	String	是	协议栈 TCP/UDP 示例值：1
ServiceName	String	否	k8s service名称 示例值：service123

QueryFilter

查询过滤器

被如下接口引用：DescribeApplications, DescribeEnvironments。

名称	类型	必选	描述
Name	String	否	查询字段名称 示例值：1
Value	Array of String	否	查询字段值 示例值：1

RunVersionPod

应用实例

被如下接口引用：DescribeApplicationInfo, DescribeApplicationPods。

名称	类型	必选	描述
Webshell	String	否	shell地址 示例值：https://tkecache.cloud.tencent.com/xxxx
PodId	String	否	pod的id 示例值：pod-jt5bn
Status	String	否	状态 示例值：Running
CreateTime	String	否	创建时间 示例值：2010-11-11 22:21:11
PodIp	String	否	实例的ip 示例值：127.0.0.1
Zone	String	否	可用区 示例值：ap-shanghai-1
DeployVersion	String	否	部署版本 示例值：20241202165113
RestartCount	Integer	否	重启次数 示例值：2
Ready	Boolean	否	pod是否就绪 示例值：true
ContainerState	String	否	容器状态 示例值：running
NodeInfo	NodeInfo	否	实例所在节点信息
StartTime	String	否	启动时间 示例值：2024-12-20T09:01:01Z
Unhealthy	Boolean	否	是否健康 注意：此字段可能返回 null，表示取不到有效值。 示例值：true
UnhealthyWarningMsg	String	否	不健康时的提示信息 示例值：message
VersionId	String	否	版本ID 示例值：revision-xxxxxx
ApplicationName	String	否	应用名称 示例值：app-name-xxx

ServicePage

服务分页

被如下接口引用：DescribeApplications。

名称	类型	必选	描述
Records	Array of TemService	是	条目 示例值：1
Total	Integer	是	总数 示例值：1
Size	Integer	是	条目 示例值：1
Pages	Integer	是	页数 示例值：1
Current	Integer	否	当前条数 示例值：1

ServicePortMapping

端口映射详细信息结构体

被如下接口引用：CreateApplicationService, DeployApplication, DescribeApplicationInfo, DescribeApplicationServiceList, ModifyApplicationService。

名称	类型	必选	描述
Type	String	否	服务类型：如：EXTERNAL，VPC，CLUSTER 示例值：ClusterIP
ServiceName	String	否	服务名称 示例值：consumer
ClusterIp	String	否	集群内访问vip 示例值：10.0.0.2
ExternalIp	String	否	集群外方位vip 示例值：202.0.0.2
SubnetId	String	否	子网id 示例值：subnet-123
VpcId	String	否	vpc id 示例值：vpc-123
LoadBalanceId	String	否	LoadBalance Id 示例值：clb-123
Yaml	String	否	yaml 内容 示例值：yaml
Ports	Array of Integer	否	暴露端口列表 示例值：[100,2000,3000]
PortMappingItemList	Array of ServicePortMappingItem	否	端口映射数组
ExternalDomain	String	否	clb domain 示例值：lb-xxxx.com

ServicePortMappingItem

服务端口映射条目

被如下接口引用：CreateApplicationService, DeployApplication, DescribeApplicationInfo, DescribeApplicationServiceList, ModifyApplicationService。

名称	类型	必选	描述
Port	Integer	否	应用访问端口 示例值：1000
TargetPort	Integer	否	应用监听端口 示例值：2000
Protocol	String	否	协议类型 示例值：TCP

ServiceVersionBrief

服务版本信息列表

被如下接口引用：DescribeApplications, DescribeApplicationsStatus, DescribeConfigData。

名称	类型	必选	描述
VersionName	String	否	版本名称 示例值：1
Status	String	否	状态 示例值：1
EnableEs	Integer	否	是否启动弹性 -- 已废弃 示例值：1
CurrentInstances	Integer	否	当前实例 示例值：10
VersionId	String	否	version的id 示例值：10
LogOutputConf	LogOutputConf	否	日志输出配置 -- 已废弃 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
ExpectedInstances	Integer	否	期望实例 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
DeployMode	String	否	部署方式 示例值：1
BuildTaskId	String	否	建构任务ID 示例值：1
EnvironmentId	String	否	环境ID 示例值：1
EnvironmentName	String	否	环境name 示例值：1
ApplicationId	String	否	服务ID 示例值：1
ApplicationName	String	否	服务name 示例值：1
UnderDeploying	Boolean	否	是否正在发布中 注意：此字段可能返回 null，表示取不到有效值。 示例值：true
BatchDeployStatus	String	否	分批次部署状态 示例值：1
Zones	Array of String	否	可用区 示例值：1
NodeInfos	Array of NodeInfo	否	节点信息 示例值：1
PodList	DescribeRunPodPage	否	实例信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
WorkloadInfo	WorkloadInfo	否	工作负载信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
CreateDate	String	否	创建日期 示例值：1
RegionId	String	否	地域id 示例值：4

SortType

查询过滤器

被如下接口引用：DescribeApplications, DescribeEnvironments。

名称	类型	必选	描述
Key	String	否	排序字段名称 示例值：1
Type	Integer	否	0：升序，1：倒序 示例值：0

StorageConf

存储卷配置

被如下接口引用：DeployApplication, DescribeApplicationInfo。

名称	类型	必选	描述
StorageVolName	String	是	存储卷名称 示例值：1
StorageVolPath	String	是	存储卷路径 示例值：1
StorageVolIp	String	否	存储卷IP 示例值：1

StorageMountConf

数据卷挂载信息

被如下接口引用：DeployApplication, DescribeApplicationInfo。

名称	类型	必选	描述
VolumeName	String	是	数据卷名 示例值：1
MountPath	String	是	数据卷绑定路径 示例值：1

Tag

标签

被如下接口引用：CreateApplication, CreateEnvironment, DescribeApplicationInfo, DescribeApplications, DescribeConfigData, DescribeEnvironment, DescribeEnvironments。

名称	类型	必选	描述
TagKey	String	否	标签键 示例值：1
TagValue	String	否	标签值 示例值：1

TemDeployApplicationDetailInfo

分批发布详情

被如下接口引用：DescribeDeployApplicationDetail。

名称	类型	描述
DeployStrategyConf	DeployStrategyConf	分批发布策略 注意：此字段可能返回 null，表示取不到有效值。
StartTime	String	开始时间 示例值：2025-02-18 18:23:09
EndTime	String	结束时间 示例值：2025-02-18 18:23:09
Status	String	当前状态 示例值：Running
BetaBatchDetail	DeployServiceBatchDetail	beta分批详情 注意：此字段可能返回 null，表示取不到有效值。
OtherBatchDetail	Array of DeployServiceBatchDetail	其他分批详情
OldVersionPodList	DescribeRunPodPage	老版本pod列表 注意：此字段可能返回 null，表示取不到有效值。
CurrentBatchIndex	Integer	当前批次id 注意：此字段可能返回 null，表示取不到有效值。 示例值：0
ErrorMessage	String	错误原因 示例值：errormesage
CurrentBatchStatus	String	当前批次状态 示例值：revert
NewDeployVersion	String	新版本version 示例值：2018222
OldDeployVersion	String	旧版本version 示例值：2018221
NewVersionPackageInfo	String	包名称 示例值：hello-world.jar
NextBatchStartTime	Integer	下一批次开始时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：12342423452

TemEnvironmentStartingStatus

环境启动进程（只统计由环境启动操作触发的应用数量）

被如下接口引用：DescribeEnvironmentStatus。

名称	类型	必选	描述
ApplicationNumNeedToStart	Integer	否	需要启动的应用数量 示例值：1
StartedApplicationNum	Integer	否	已经启动的应用数量 示例值：1
StartFailedApplicationNum	Integer	否	启动失败的应用数量 示例值：1

TemEnvironmentStoppingStatus

环境停止进程（只统计由环境停止操作触发的应用数量）

被如下接口引用：DescribeEnvironmentStatus。

名称	类型	必选	描述
ApplicationNumNeedToStop	Integer	否	需要停止的应用数量 示例值：1
StoppedApplicationNum	Integer	否	已经停止的应用数量 示例值：1
StopFailedApplicationNum	Integer	否	停止失败的应用数量 示例值：1

TemNamespaceInfo

命名空间对象

被如下接口引用：DescribeEnvironments。

名称	类型	描述
EnvironmentId	String	环境id 示例值：en-xxxxxx
Channel	String	渠道 示例值：0
EnvironmentName	String	环境名称 示例值：en-name-xxx
Region	String	区域名称 示例值：ap-shanghai
Description	String	环境描述 示例值：这是一个描述
Status	Integer	状态,1:已销毁;0:正常 示例值：1
Vpc	String	vpc网络 示例值：vpc-xxxxxx
CreateDate	String	创建时间 示例值：2024-10-29 18:53:24
ModifyDate	String	修改时间 示例值：2024-10-29 18:53:24
Modifier	String	修改人 示例值：10001xxxxx
Creator	String	创建人 示例值：10001xxxxx
ApplicationNum	Integer	应用数 示例值：2
RunInstancesNum	Integer	运行实例数 示例值：2
SubnetId	String	子网络 示例值：subnet-xxxxxx
ClusterStatus	String	环境集群 status 示例值：NORMAL
EnableTswTraceService	Boolean	是否开启tsw 示例值：true
Locked	Integer	环境锁，1为上锁，0则为上锁 示例值：1
AppId	String	用户AppId 示例值：1305xxxxxx
Uin	String	用户Uin 示例值：100019xxxxxx
SubAccountUin	String	用户SubAccountUin 示例值：100039xxxxxx
ClusterId	String	集群ID 示例值：cls-xxxxxx
Tags	Array of Tag	标签
HasAuthority	Boolean	资源是否有权限 示例值：false
EnvType	String	环境类型: test、pre、prod 示例值：prod
RegionId	String	地域码 示例值：4

TemService

服务

被如下接口引用：DescribeApplications, DescribeConfigData。

名称	类型	必选	描述
ApplicationId	String	否	主键 示例值：1
ApplicationName	String	否	服务名 示例值：10
Description	String	否	描述 示例值：10
EnvironmentId	String	否	命名空间id 示例值：1
CreateDate	Timestamp	否	创建时间 示例值：10
ModifyDate	Timestamp	否	修改时间 示例值：10
Modifier	String	否	修改人 示例值：1
Creator	String	否	创建者 示例值：1
RepoType	Integer	否	tcr个人版or企业版 示例值：0
InstanceId	String	否	企业版实例id 示例值：id123
RepoName	String	否	镜像仓库名 示例值：tem-ns/repo
CodingLanguage	String	否	编程语言 示例值：1
DeployMode	String	否	部署方式 示例值：1
EnvironmentName	String	否	环境名称 示例值：1
ActiveVersions	Array of ServiceVersionBrief	否	服务当前运行环境的实例信息 示例值：1
EnableTracing	Integer	否	是否启用链路追踪 示例值：1
Tags	Array of Tag	否	标签 示例值：1
HasAuthority	Boolean	否	是否有资源权限 示例值：1

TemServiceVersionInfo

版本信息

被如下接口引用：DescribeApplicationInfo。

名称	类型	必选	描述
VersionId	String	是	主键 示例值：revision-xxxxxx
ApplicationId	String	是	服务id 示例值：app-xxxxxx
DeployMode	String	是	部署方式 示例值：JAR
JdkVersion	String	是	jdk版本 示例值：KONA:11
Description	String	是	描述 示例值：这是一个描述
DeployVersion	String	是	部署版本 示例值：20241016164535
PublishMode	String	是	发布方式 示例值：RollingUpdate
JvmOpts	String	是	启动参数 示例值：-Xms128m -XX:MetaspaceSize=128m
InitPodNum	Integer	是	初始实例 示例值：2
CpuSpec	Float	是	cpu规格 示例值：2
MemorySpec	Float	是	内存规格 示例值：4
ImgRepo	String	是	镜像路径 示例值：img-repo-xxx
ImgName	String	是	镜像名称 示例值：tem-xxxx/image-name
ImgVersion	String	是	镜像版本 示例值：20241016164535
EsInfo	EsInfo	是	弹性配置 注意：此字段可能返回 null，表示取不到有效值。
EnvConf	Array of Pair	是	环境配置
StorageConfs	Array of StorageConf	是	存储配置
Status	String	是	运行状态 示例值：normal
Vpc	String	是	私有网络 示例值：vpc-xxxxxx
SubnetId	String	是	子网网络 示例值：subnet-xxxxxx
CreateDate	String	是	创建时间 示例值：2024-10-16 16:45:17
ModifyDate	String	是	修改时间 示例值：2024-10-16 16:45:17
StorageMountConfs	Array of StorageMountConf	是	挂载配置
VersionName	String	是	版本名称 示例值：version-name-xxx
LogOutputConf	LogOutputConf	否	日志输出配置 注意：此字段可能返回 null，表示取不到有效值。
ApplicationName	String	否	服务名称 示例值：app-name-xxx
ApplicationDescription	String	否	服务描述 示例值：这是一个描述
EnvironmentName	String	否	环境名称 示例值：env-name-xxx
EnvironmentId	String	否	环境ID 示例值：en-xxxxxx
PublicDomain	String	否	公网地址 示例值：pub-domain-xxx.com
EnablePublicAccess	Boolean	否	是否开通公网访问 注意：此字段可能返回 null，表示取不到有效值。 示例值：true
CurrentInstances	Integer	否	现有的实例 示例值：2
ExpectedInstances	Integer	否	期望的实例 注意：此字段可能返回 null，表示取不到有效值。 示例值：2
CodingLanguage	String	否	编程语言 示例值：JAVA
PkgName	String	否	程序包名 示例值：tem/pkg/xxx/app-xxx/xxxxx/helloworld.jar
EsEnable	Integer	否	是否启用弹性伸缩 注意：此字段可能返回 null，表示取不到有效值。 示例值：0
EsStrategy	Integer	否	弹性策略 注意：此字段可能返回 null，表示取不到有效值。 示例值：0
ImageTag	String	否	镜像tag 示例值：20241016164535
LogEnable	Integer	否	是否启用log 注意：此字段可能返回 null，表示取不到有效值。 示例值：0
MinAliveInstances	String	否	最小实例数 示例值：2
SecurityGroupIds	Array of String	否	安全组 示例值：sg-xxxxxx
ImageCommand	String	否	镜像命令 示例值：ls
ImageArgs	Array of String	否	镜像命令参数 注意：此字段可能返回 null，表示取不到有效值。 示例值：["-c", "100"]
UseRegistryDefaultConfig	Boolean	否	是否使用默认注册中心配置 示例值：false
Service	EksService	否	eks 访问设置
SettingConfs	Array of MountedSettingConf	否	挂载配置信息
LogConfs	Array of String	否	log path数组信息 示例值：["/path"]
PostStart	String	否	启动后立即执行的脚本 示例值：post-start-shell-xxx
PreStop	String	否	停止前执行的脚本 示例值：pre-stop-shell-xxx
Liveness	HealthCheckConfig	否	存活探针配置 注意：此字段可能返回 null，表示取不到有效值。
Readiness	HealthCheckConfig	否	就绪探针配置 注意：此字段可能返回 null，表示取不到有效值。
HorizontalAutoscaler	Array of HorizontalAutoscaler	否	弹性策略
CronHorizontalAutoscaler	Array of CronHorizontalAutoscaler	否	定时弹性策略
Zones	Array of String	否	应用实际可用区 示例值：["ap-shanghai-2"]
LastDeployDate	String	否	最新部署时间 示例值：2024-12-09 10:40:31
LastDeploySuccessDate	String	否	最新部署成功时间 示例值：LastDeploySuccessDate
NodeInfos	Array of NodeInfo	否	应用所在node信息
ImageType	Integer	否	image类型 -0 为demo -1为正常image 示例值：0
EnableTracing	Integer	否	是否启用调用链组件 示例值：1
EnableTracingReport	Integer	否	是否开启调用链上报，只有 EnableTracing=1 时生效（参数已弃用） 示例值：1
RepoType	Integer	否	镜像类型：0-个人镜像、1-企业镜像、2-公有镜像 示例值：2
BatchDeployStatus	String	否	分批发布子状态：batch_updating、batch_updating_waiting_confirm 示例值：batch_updating
ApmInstanceId	String	否	APM 资源 ID 示例值：apm-xxx
WorkloadInfo	WorkloadInfo	否	工作负载信息
SpeedUp	Boolean	否	是否启用应用加速 示例值：true
StartupProbe	HealthCheckConfig	否	启动检测探针配置 注意：此字段可能返回 null，表示取不到有效值。
OsFlavour	String	否	操作系统版本，可选参数： - ALPINE - CENTOS 示例值：ALPINE
RepoServer	String	否	镜像仓库server 示例值：tem-sh-custom-xxxxxx.tencentcloudcr.com
UnderDeploying	Boolean	否	是否正在发布中 示例值：true
EnablePrometheusConf	EnablePrometheusConf	否	监控业务指标监控 注意：此字段可能返回 null，表示取不到有效值。 示例值：{"Port":9090,"Path:"/data"}
StoppedManually	Boolean	否	是否为手动停止 示例值：true
TcrInstanceId	String	否	tcr实例ID 示例值：tcr-xxxxxx
EnableMetrics	Integer	否	1：开始自动metrics采集（open-telemetry）； 0：关闭metrics采集； 示例值：1
AppId	String	否	用户AppId 示例值：130xxxxxx
SubAccountUin	String	否	用户SubAccountUin 示例值：10000xxxxx
Uin	String	否	用户Uin 示例值：10001xxxxx
Region	String	否	地域 示例值：ap-shanghai
GroupId	String	否	应用分组ID 示例值：group-xxxxxx
EnableRegistry	Integer	否	是否启用注册中心 示例值：1
AutoscalerList	Array of Autoscaler	否	弹性伸缩数组
Modifier	String	否	修改人 示例值：100019xxxxxx
Creator	String	否	创建人 示例值：100019xxxxxx
DeployStrategyConf	DeployStrategyConf	否	部署策略 注意：此字段可能返回 null，表示取不到有效值。
PodList	DescribeRunPodPage	否	实例列表
ConfEdited	Boolean	否	发布时配置是否有修改 注意：此字段可能返回 null，表示取不到有效值。 示例值：true
Tags	Array of Tag	否	标签
PreStopEncoded	String	否	是否编码 示例值：PreStopEncoded-xxx
PostStartEncoded	String	否	是否编码 示例值：PostStartEncoded-xxx

UseDefaultRepoParameters

创建应用，创建仓库参数

被如下接口引用：CreateApplication。

名称	类型	必选	描述
EnterpriseInstanceName	String	否	企业版实例名 示例值：tcr-demo-xxx
EnterpriseInstanceChargeType	Integer	否	企业版收费类型 0 按量收费 1 包年包月 示例值：0
EnterpriseInstanceType	String	否	企业版规格：basic-基础班 ，standard-标准版，premium-高级版 示例值：basic

WorkloadInfo

工作负载详情

被如下接口引用：DescribeApplicationInfo, DescribeApplicationsStatus。

名称	类型	必选	描述
ClusterId	String	否	资源 ID 示例值：cls-xxx
ApplicationName	String	否	应用名 示例值：appName-xxx
VersionName	String	否	版本名称 示例值：version-name-xxx
ReadyReplicas	Integer	否	Ready实例数 示例值：1
Replicas	Integer	否	实例数 示例值：2
UpdatedReplicas	Integer	否	Updated实例数 示例值：1
UpdatedReadyReplicas	Integer	否	UpdatedReady实例数 示例值：1
UpdateRevision	String	否	更新版本 示例值：revision-xxxxxx
CurrentRevision	String	否	当前版本 示例值：revision-xxxxxx