数据结构

AddInstanceResult

添加实例到集群的结果

被如下接口引用：AddClusterInstances。

名称	类型	描述
FailedInstanceIds	Array of String	添加集群失败的节点列表 示例值：["ins-6a79x94v"]
SuccInstanceIds	Array of String	添加集群成功的节点列表 示例值：["ins-6a79x94v"]
TimeoutInstanceIds	Array of String	添加集群超时的节点列表 示例值：["ins-6a79x94v"]
FailedReasons	Array of String	失败的节点的失败原因 注意：此字段可能返回 null，表示取不到有效值。 示例值：["this is a reason"]

AdvanceSettings

高级选项设置

被如下接口引用：CreateTask, DescribeTaskDetail, DescribeTaskRecords, ModifyTask。

名称	类型	必选	描述
SubTaskConcurrency	Integer	否	子任务单机并发数限制，默认值为2 示例值：2

Affinity

亲和规则

被如下接口引用：DeployContainerApplication, DeployContainerGroup。

名称	类型	必选	描述
Scope	String	否	亲和性范围 示例值：Node
Weight	String	否	亲和规则的权重 示例值：50
Paths	Array of CommonOption	否	-

AgentProfile

部署javaagent的类型、版本信息

被如下接口引用：DeployContainerApplication, DeployContainerGroup, DeployGroup, DescribeGroup。

名称	类型	必选	描述
AgentType	String	否	Agent类型 示例值：SERVICE_AGENT/OT_AGENT
AgentVersion	String	否	Agent版本号 示例值：release/1.0

ApiDefinitionDescr

API 对象类型描述

被如下接口引用：DescribeApiDetail。

名称	类型	描述
Name	String	对象名称 示例值：API_DEFI
Properties	Array of PropertyField	对象属性列表 示例值：[{"Name":"tag_user","Type":"string","Description":"This is desc"}]

ApiDetailInfo

API 明细

被如下接口引用：ChangeApiUsableStatus, DescribeGatewayApis。

名称	类型	描述
ApiId	String	API ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：api-0i1r0zuh
NamespaceId	String	命名空间ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：namespace-qab7bq9v
NamespaceName	String	命名空间名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：ns_default
MicroserviceId	String	服务ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：ms-ba2jlxvk
MicroserviceName	String	服务名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：provider-demo
Path	String	API 请求路径 注意：此字段可能返回 null，表示取不到有效值。 示例值：/checkToken
PathMapping	String	Api 映射路径 注意：此字段可能返回 null，表示取不到有效值。 示例值：/checkToken
Method	String	请求方法 注意：此字段可能返回 null，表示取不到有效值。 示例值：GET
GroupId	String	所属分组ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：grp-nb08ur29
UsableStatus	String	是否禁用 注意：此字段可能返回 null，表示取不到有效值。 示例值：enabled
ReleaseStatus	String	发布状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：released
RateLimitStatus	String	开启限流 注意：此字段可能返回 null，表示取不到有效值。 示例值：disabled
MockStatus	String	是否开启mock 注意：此字段可能返回 null，表示取不到有效值。 示例值：disabled
CreatedTime	String	创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-12-23 01:30:03
UpdatedTime	String	更新时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-12-23 01:30:03
ReleasedTime	String	发布时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-12-23 01:30:03
GroupName	String	所属分组名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：grp_name
Timeout	Integer	API 超时，单位毫秒 注意：此字段可能返回 null，表示取不到有效值。 示例值：10000
Host	String	Api所在服务host 注意：此字段可能返回 null，表示取不到有效值。 示例值：http://www.qq.com
ApiType	String	API类型。 ms ： 微服务API； external :外部服务Api 注意：此字段可能返回 null，表示取不到有效值。 示例值：ms
Description	String	Api描述信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：This is desc
ApiMatchType	String	API路径匹配类型。normal：普通API；wildcard：通配API。 注意：此字段可能返回 null，表示取不到有效值。 示例值：normal
RpcExt	String	RPC 额外信息 注意：此字段可能返回 null，表示取不到有效值。
GatewayDeployGroupId	String	部署组id 注意：此字段可能返回 null，表示取不到有效值。 示例值：group-ldap5yok
Md5	String	md5 注意：此字段可能返回 null，表示取不到有效值。 示例值：37025610cc82b1a9a8f192159c6di3d9
RpcType	String	RPC 类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：http

ApiDetailResponse

ApiDetailResponse描述

被如下接口引用：DescribeApiDetail。

名称	类型	描述
Request	Array of ApiRequestDescr	API 请求参数 示例值：[{"Name":"str","Type":"string","Description":"str","Required":true,"In":"path","DefaultValue":null}]
Response	Array of ApiResponseDescr	API 响应参数 注意：此字段可能返回 null，表示取不到有效值。 示例值：[{"Name":"_RESPONSE","Type":"string","Description":"OK"}]
Definitions	Array of ApiDefinitionDescr	API 复杂结构定义 示例值：[{"Name":"","Properties":[{"Name":"","Type":"","Description":""}]}]
RequestContentType	String	API 的 content type 注意：此字段可能返回 null，表示取不到有效值。 示例值："application/json"
CanRun	Boolean	API 能否调试 示例值：true
Status	Integer	API 状态 0:离线 1:在线，默认0 示例值：1
Description	String	API 描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：This is desc

ApiGroupInfo

API分组信息

被如下接口引用：DescribeApiGroup, DescribeApiGroups, DescribeGroupGateways, DescribeGroupsWithPlugin。

名称	类型	描述
GroupId	String	Api Group Id 注意：此字段可能返回 null，表示取不到有效值。 示例值：grp-vcgimq3x
GroupName	String	Api Group 名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：group-name
GroupContext	String	分组上下文 注意：此字段可能返回 null，表示取不到有效值。 示例值：/provider
AuthType	String	鉴权类型。 secret： 密钥鉴权； none:无鉴权 注意：此字段可能返回 null，表示取不到有效值。 示例值：none
Status	String	发布状态, drafted: 未发布。 released: 发布 注意：此字段可能返回 null，表示取不到有效值。 示例值：released
CreatedTime	String	分组创建时间 如:2019-06-20 15:51:28 注意：此字段可能返回 null，表示取不到有效值。 示例值：2019-06-20 15:51:28
UpdatedTime	String	分组更新时间 如:2019-06-20 15:51:28 注意：此字段可能返回 null，表示取不到有效值。 示例值：2019-06-20 15:51:28
BindedGatewayDeployGroups	Array of GatewayDeployGroup	api分组已绑定的网关部署组 注意：此字段可能返回 null，表示取不到有效值。 示例值：[{"DeployGroupId":"group-ym9mqx2a","DeployGroupName":"heihuli-zuul-unit","ApplicationId":"application-yq58wpey","ApplicationName":"gateway-gw","ApplicationType":"V","GroupStatus":null,"ClusterType":"V"}]
ApiCount	Integer	api 个数 注意：此字段可能返回 null，表示取不到有效值。 示例值：10
AclMode	String	访问group的ACL类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：none
Description	String	描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：This is desc
GroupType	String	分组类型。 ms： 微服务分组； external:外部Api分组 注意：此字段可能返回 null，表示取不到有效值。 示例值：ms
GatewayInstanceType	String	网关实例的类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：unit
GatewayInstanceId	String	网关实例ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：ins-szesmg28
NamespaceNameKey	String	命名空间参数key值 注意：此字段可能返回 null，表示取不到有效值。 示例值：TSF-NamespaceName
ServiceNameKey	String	微服务名参数key值 注意：此字段可能返回 null，表示取不到有效值。 示例值：TSF-ServiceName
NamespaceNameKeyPosition	String	命名空间参数位置，path，header或query，默认是path 注意：此字段可能返回 null，表示取不到有效值。 示例值：path
ServiceNameKeyPosition	String	微服务名参数位置，path，header或query，默认是path 注意：此字段可能返回 null，表示取不到有效值。 示例值：path
GatewayInstanceIdList	Array of String	网关实例ID列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：["gw-ins-szesmg28"]

ApiInfo

微服务网关API信息

被如下接口引用：CreateGatewayApi。

名称	类型	必选	描述
NamespaceId	String	是	命名空间Id，若为外部API,为固定值："namespace-external" 示例值：namespace-96a79v5b
MicroserviceId	String	是	服务Id，若为外部API,为固定值："ms-external" 示例值：ms-by8o5kgv
Path	String	是	API path 示例值：/echo
Method	String	是	Api 请求 示例值：GET
PathMapping	String	是	请求映射 示例值：/echo
Host	String	否	api所在服务host,限定外部Api填写。格式: http://127.0.0.1:8080 示例值：www.qq.com
Description	String	否	api描述信息 示例值：This is desc

ApiRateLimitRule

微服务网关API限流规则

被如下接口引用：CreateApiRateLimitRuleWithDetailResp, DescribeApiRateLimitRules。

名称	类型	描述
RuleId	String	rule Id 注意：此字段可能返回 null，表示取不到有效值。 示例值：rule-ov3yyria
ApiId	String	API ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：api-c5tc8x6j
RuleName	String	限流名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：gateway-proxy-rule_grp-kehvi94a_api-c5tc8x6j
MaxQps	Integer	最大限流qps 注意：此字段可能返回 null，表示取不到有效值。 示例值：10000
UsableStatus	String	生效/禁用, enabled/disabled 注意：此字段可能返回 null，表示取不到有效值。 示例值：enabled
RuleContent	String	规则内容 注意：此字段可能返回 null，表示取不到有效值。 示例值：忽略，接口冗余字段。
TsfRuleId	String	Tsf Rule ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：rate-9ov6lpv3
Description	String	描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：This is desc
CreatedTime	String	创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-12-19 21:00:00
UpdatedTime	String	更新时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-12-19 21:00:00
Limit	Integer	分页参数limit 注意：此字段可能返回 null，表示取不到有效值。 示例值：10
Offset	Integer	分页参数offset 注意：此字段可能返回 null，表示取不到有效值。 示例值：0
AppId	String	AppId 注意：此字段可能返回 null，表示取不到有效值。 示例值：1

ApiRequestDescr

ApiRequestDescr

被如下接口引用：DescribeApiDetail。

名称	类型	描述
Name	String	参数名称 示例值：tag_user
Type	String	参数类型 示例值：string
In	String	参数位置 示例值：query
Description	String	参数描述 示例值：This is desc
Required	Boolean	参数是否必须 示例值：false
DefaultValue	String	参数的默认值 注意：此字段可能返回 null，表示取不到有效值。 示例值：def_user

ApiResponseDescr

API 响应的参数结构描述

被如下接口引用：DescribeApiDetail。

名称	类型	描述
Name	String	参数描述 示例值：_RESPONSE
Type	String	参数类型 示例值：string
Description	String	参数描述 示例值：OK

ApiUseStatisticsEntity

API 日统计数据点

被如下接口引用：DescribeApiUseDetail, DescribeUnitApiUseDetail。

名称	类型	描述
Name	String	名称 示例值：2xx
Count	String	次数 示例值：39723
Ratio	String	比率 示例值：0.99

ApiVersionArray

API版本数组

被如下接口引用：DescribeApiVersions。

名称	类型	描述
ApplicationId	String	App ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：application-l6ymbvgd
ApplicationName	String	App 名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：app_provider
PkgVersion	String	App 包版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：v1

ApplicationAttribute

应用列表其它字段

被如下接口引用：DescribeApplicationAttribute。

名称	类型	描述
InstanceCount	Integer	总实例个数 示例值：3
RunInstanceCount	Integer	运行实例个数 示例值：2
GroupCount	Integer	应用下部署组个数 示例值：2
RunningGroupCount	String	运行中部署组个数 示例值：2
AbnormalCount	String	异常部署组个数 示例值：0

ApplicationForPage

分页的应用描述信息字段

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

名称	类型	描述
ApplicationId	String	应用ID 示例值：application-6a79x94v
ApplicationName	String	应用名称 示例值：java-provider
ApplicationDesc	String	应用描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：this is a desc
ApplicationType	String	应用类型 示例值：C
MicroserviceType	String	微服务类型 示例值：DEF
ProgLang	String	编程语言 示例值：J
CreateTime	String	创建时间 示例值：2019-11-21 09:33:21
UpdateTime	String	更新时间 示例值：2019-11-22 09:33:21
ApplicationResourceType	String	应用资源类型 示例值：C
ApplicationRuntimeType	String	应用runtime类型 示例值：konaJdk8
ApigatewayServiceId	String	Apigateway的serviceId 示例值：gw-ins-6a79x94v
ApplicationRemarkName	String	应用备注名 注意：此字段可能返回 null，表示取不到有效值。 示例值：remark-mock
ServiceConfigList	Array of ServiceConfig	服务配置信息列表 注意：此字段可能返回 null，表示取不到有效值。
IgnoreCreateImageRepository	Boolean	IgnoreCreateImageRepository 示例值：true
ApmInstanceId	String	Apm业务系统id 注意：此字段可能返回 null，表示取不到有效值。 示例值：apm-6a79x94v
ApmInstanceName	String	Apm业务系统Name 注意：此字段可能返回 null，表示取不到有效值。 示例值：apm-mock
SyncDeleteImageRepository	Boolean	同步删除镜像仓库 注意：此字段可能返回 null，表示取不到有效值。 示例值：true
MicroserviceSubType	String	应用微服务子类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：N
ProgramLanguage	String	应用编程语言类型 示例值：Java
FrameworkType	String	开发框架类型[SpringCloud，Dubbo，Go-GRPC，Other] 示例值：Spring Cloud
ServiceGovernanceConfig	ServiceGovernanceConfig	注册配置治理信息
MicroserviceTypeList	Array of String	微服务类型列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：["N"]
CreateSameNameImageRepository	Boolean	是否同时创建镜像仓库 示例值：true

AvailableZoneScatterScheduleRule

打散调度规则

被如下接口引用：DeployContainerApplication, DeployContainerGroup。

名称	类型	必选	描述
ScatterDimension	String	否	- 示例值：Application
MaxUnbalanceQuantity	Integer	否	- 示例值：25
IsForceSchedule	Boolean	否	- 示例值：true
Paths	Array of CommonOption	否	-

BusinessLogConfig

业务日志配置

被如下接口引用：DescribeBusinessLogConfig, DescribeBusinessLogConfigs, DescribeGroupBusinessLogConfigs。

名称	类型	必选	描述
ConfigId	String	否	配置项ID 示例值：apm-busi-log-cfg-qabp49vl
ConfigName	String	否	配置项名称 示例值：config-mock
ConfigPath	String	否	配置项日志路径 示例值：/config
ConfigDesc	String	否	配置项描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：this is a desc
ConfigTags	String	否	配置项标签 注意：此字段可能返回 null，表示取不到有效值。 示例值：tag1
ConfigPipeline	String	否	配置项对应的ES管道 示例值：pipeline1
ConfigCreateTime	String	否	配置项创建时间，格式为yyyy-MM-dd HH:mm:ss 注意：此字段可能返回 null，表示取不到有效值。 示例值：2019-11-21 11:31:34
ConfigUpdateTime	String	否	配置项更新时间，格式为yyyy-MM-dd HH:mm:ss 注意：此字段可能返回 null，表示取不到有效值。 示例值：2019-11-22 11:31:34
ConfigSchema	BusinessLogConfigSchema	否	配置项解析规则
ConfigAssociatedGroupList	Array of BusinessLogConfigAssociatedGroup	否	配置项关联部署组
FilebeatConfigEnable	Boolean	否	是否开启filebeat高级配置开关 示例值：false
FilebeatCloseTimeout	Integer	否	close_timeout参数 示例值：10
FilebeatIgnoreOlder	Integer	否	filebeat ignore_older参数 示例值：10
FilebeatHarvesterLimit	Integer	否	filebeat harvester_limit参数 示例值：100
FilebeatCloseInactive	Integer	否	filebeat close_inactive参数 示例值：10
FilebeatCleanInactive	Integer	否	filebeat clean_inactive参数 示例值：20

BusinessLogConfigAssociatedGroup

业务日志配置关联部署组信息

被如下接口引用：DescribeBusinessLogConfig, DescribeBusinessLogConfigs, DescribeGroupBusinessLogConfigs。

名称	类型	必选	描述
GroupId	String	是	部署组ID 示例值：group-6a79x94v
GroupName	String	是	部署组名称 示例值：group-mock
ApplicationId	String	是	部署组所属应用ID 示例值：application-6a79x94v
ApplicationName	String	是	部署组所属应用名称 示例值：java-app
ApplicationType	String	是	部署组所属应用类型，C：容器应用，V：虚拟机应用 示例值：C
NamespaceId	String	是	部署组所属命名空间ID 示例值：namespace-6a79x94v
NamespaceName	String	是	部署组所属命名空间名称 示例值：my-namespace
ClusterId	String	是	部署组所属集群ID 示例值：cls-6a79x94v
ClusterName	String	是	部署组所属集群名称 示例值：cls-mock
ClusterType	String	是	部署组所属集群类型，C：容器集群，V：虚拟机集群 示例值：C
AssociatedTime	String	是	部署组关联日志配置时间，格式yyyy-MM-dd HH:mm:ss 示例值：2020-01-12 12:33:12

BusinessLogConfigSchema

业务日志配置解析规则

被如下接口引用：DescribeBusinessLogConfig, DescribeBusinessLogConfigs, DescribeGroupBusinessLogConfigs。

名称	类型	必选	描述
SchemaType	Integer	是	解析规则类型。可选值 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日志）。 示例值：1
SchemaContent	String	否	解析规则内容 注意：此字段可能返回 null，表示取不到有效值。 示例值：spring-log-xxxxxxxxxx
SchemaDateFormat	String	否	解析规则时间格式 注意：此字段可能返回 null，表示取不到有效值。 示例值：yy-MM-dd HH:mm:ss
SchemaMultilinePattern	String	否	解析规则对应的多行匹配规则 注意：此字段可能返回 null，表示取不到有效值。 示例值：/t/n
SchemaCreateTime	String	否	解析规则创建时间，格式为yyyy-MM-dd HH:mm:ss 示例值：2020-12-30 12:34:56
SchemaPatternLayout	String	否	用户填写的解析规则 注意：此字段可能返回 null，表示取不到有效值。 示例值：.*

BusinessLogV2

业务日志

被如下接口引用：SearchBusinessLog。

名称	类型	描述
InstanceId	String	实例ID 示例值：ins-6a79x94v
Content	String	日志内容 示例值：log-xxxxxxxxxxxxxx
Timestamp	Integer	日志时间戳，单位毫秒 示例值：1792739028
InstanceIp	String	实例IP 示例值：10.23.39.2
LogId	String	日志ID 示例值：log-6a79x94v
GroupId	String	部署组ID 示例值：group-6a79x94v

Cluster

集群

被如下接口引用：DescribeSimpleClusters, DescribeSimpleNamespaces。

名称	类型	描述
ClusterId	String	集群ID 示例值：cls-6a79x94v
ClusterName	String	集群名称 示例值：k8s-cls
ClusterDesc	String	集群描述 示例值：this is a desc
ClusterType	String	集群类型 示例值：C
VpcId	String	集群所属私有网络ID 示例值：vpc-6a79x94v
ClusterStatus	String	集群状态 示例值：Running
ClusterCIDR	String	集群CIDR 示例值：10.10.3.1/16
ClusterTotalCpu	Float	集群总CPU，单位: 核 示例值：64
ClusterTotalMem	Float	集群总内存，单位: G 示例值：256
ClusterUsedCpu	Float	集群已使用CPU，单位: 核 示例值：23
ClusterUsedMem	Float	集群已使用内存，单位: G 示例值：88
InstanceCount	Integer	集群机器实例数量 示例值：4
RunInstanceCount	Integer	集群可用的机器实例数量 示例值：4
NormalInstanceCount	Integer	集群正常状态的机器实例数量 示例值：4
DeleteFlag	Boolean	删除标记：true：可以删除；false：不可删除 示例值：false
CreateTime	String	创建时间 示例值：2019-12-23 12:23:32
UpdateTime	String	更新时间 示例值：2019-12-27 12:23:32
TsfRegionId	String	集群所属TSF地域ID 示例值：7
TsfRegionName	String	集群所属TSF地域名称 示例值：ap-guangzhou
TsfZoneId	String	集群所属TSF可用区ID 示例值：50010001
TsfZoneName	String	集群所属TSF可用区名称 示例值：az1
DeleteFlagReason	String	集群不可删除的原因 示例值：集群有运行中资源
ClusterLimitCpu	Float	集群最大CPU限制，单位：核 示例值：56
ClusterLimitMem	Float	集群最大内存限制，单位：G 示例值：240
RunServiceInstanceCount	Integer	集群可用的服务实例数量 示例值：160
SubnetId	String	集群所属子网ID 示例值：subnet-6a79x94v
OperationInfo	OperationInfo	返回给前端的控制信息
ClusterVersion	String	集群版本 示例值：1.22

ClusterV2

集群详情

被如下接口引用：DescribeClusters。

名称	类型	描述
ClusterId	String	集群ID 示例值：cls-6a79x94v
ClusterName	String	集群名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：k8s-cls
ClusterDesc	String	集群描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：this is desc
ClusterType	String	集群类型，C表示容器集群，V表示虚拟机集群 注意：此字段可能返回 null，表示取不到有效值。 示例值：C
VpcId	String	集群所属私有网络ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：vpc-6a79x94v
ClusterStatus	String	集群状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：Running
ClusterCIDR	String	集群CIDR 注意：此字段可能返回 null，表示取不到有效值。 示例值：10.2.30.3/16
ClusterTotalCpu	Float	集群总CPU，单位: 核 注意：此字段可能返回 null，表示取不到有效值。 示例值：128.0
ClusterTotalMem	Float	集群总内存，单位: G 注意：此字段可能返回 null，表示取不到有效值。 示例值：999.0
ClusterUsedCpu	Float	集群已使用CPU，单位: 核 注意：此字段可能返回 null，表示取不到有效值。 示例值：64.0
ClusterUsedMem	Float	集群已使用内存，单位: G 注意：此字段可能返回 null，表示取不到有效值。 示例值：600.0
InstanceCount	Integer	集群机器实例数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：5
RunInstanceCount	Integer	集群运行中的机器实例数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：5
NormalInstanceCount	Integer	集群正常状态的机器实例数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：5
DeleteFlag	Boolean	删除标记：true：可以删除；false：不可删除 注意：此字段可能返回 null，表示取不到有效值。 示例值：false
CreateTime	String	创建时间，格式为​​YYYY-MM-DD HH:MM:SS 注意：此字段可能返回 null，表示取不到有效值。 示例值：2019-12-13 12:31:12
UpdateTime	String	更新时间，格式为​​YYYY-MM-DD HH:MM:SS 注意：此字段可能返回 null，表示取不到有效值。 示例值：2019-12-13 12:31:12
TsfRegionId	String	集群所属TSF地域ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：7
TsfRegionName	String	集群所属TSF地域名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：ap-guangzhou
TsfZoneId	String	集群所属TSF可用区ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：29
TsfZoneName	String	集群所属TSF可用区名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：az1
DeleteFlagReason	String	集群不可删除的原因 注意：此字段可能返回 null，表示取不到有效值。 示例值：集群有资源未解绑
SubnetId	String	集群所属私有网络子网ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：subnet-6a79x94v
ClusterLimitCpu	String	集群剩余 cpu limit 注意：此字段可能返回 null，表示取不到有效值。 示例值：44
ClusterLimitMem	String	集群剩余 memory limit 注意：此字段可能返回 null，表示取不到有效值。 示例值：23
RunServiceInstanceCount	Integer	运行服务实例数 注意：此字段可能返回 null，表示取不到有效值。 示例值：43
OperationInfo	OperationInfo	给前端的按钮控制信息 注意：此字段可能返回 null，表示取不到有效值。
ClusterVersion	String	容器集群版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：1.24
GroupCount	Integer	部署组总数 注意：此字段可能返回 null，表示取不到有效值。 示例值：43
RunGroupCount	Integer	运行中部署组数 注意：此字段可能返回 null，表示取不到有效值。 示例值：43
StopGroupCount	Integer	停止中部署组数 注意：此字段可能返回 null，表示取不到有效值。 示例值：0
AbnormalGroupCount	Integer	异常部署组数 注意：此字段可能返回 null，表示取不到有效值。 示例值：0
ClusterRemarkName	String	集群备注名 注意：此字段可能返回 null，表示取不到有效值。 示例值：remark-mock
KuberneteApiServer	String	api地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：http://10.29.23.1:6443
KuberneteNativeType	String	K 表示通过kubeconfig 导入, S 表示通过service account导入 注意：此字段可能返回 null，表示取不到有效值。 示例值：S
KuberneteNativeSecret	String	Kubernetes 密钥 注意：此字段可能返回 null，表示取不到有效值。 示例值：secret-mock-U2FsdGVkX1+dOP
EnableLogCollection	Boolean	是否开启cls日志功能 示例值：false
Reason	String	集群状态的原因 示例值：this is a reson

CommonOption

通用选项

被如下接口引用：DeployContainerApplication, DeployContainerGroup。

名称	类型	必选	描述
LabelName	String	否	- 示例值：GroupId
Operator	String	否	- 示例值：eqauls
LabelValue	String	否	- 示例值：group-6a79x94v

CommonRef

ValueFrom 通用结构

被如下接口引用：DeployContainerApplication, DeployContainerGroup, DescribeContainerGroupDeployInfo。

名称	类型	必选	描述
Name	String	否	名称 示例值：name-mock
Key	String	否	Key值 示例值：key-mock

Config

配置项

被如下接口引用：CreateConfigWithDetailResp, CreatePublicConfigWithDetailResp, DescribeConfig, DescribeConfigSummary, DescribeConfigs, DescribePublicConfig, DescribePublicConfigSummary, DescribePublicConfigs。

名称	类型	描述
ConfigId	String	配置项ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：dcfg-5zvw59v8
ConfigName	String	配置项名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：config_app
ConfigVersion	String	配置项版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：v1.0
ConfigVersionDesc	String	配置项版本描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：This is desc
ConfigValue	String	配置项值 注意：此字段可能返回 null，表示取不到有效值。 示例值：api.invok.limit: 5000
ConfigType	String	配置项类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：application
CreationTime	String	创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-12-04 16:18:21
ApplicationId	String	应用ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：application-l6ymbvgd
ApplicationName	String	应用名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：app-provider
DeleteFlag	Boolean	删除标识，true：可以删除；false：不可删除 注意：此字段可能返回 null，表示取不到有效值。 示例值：true
LastUpdateTime	String	最后更新时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-12-04 16:18:21
ConfigVersionCount	Integer	配置项版本数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：1

ConfigMapOption

ConfigMap可选项

被如下接口引用：DeployContainerApplication, DeployContainerGroup, DescribeContainerGroupDeployInfo。

名称	类型	必选	描述
Key	String	否	- 示例值：key-mock
Path	String	否	- 示例值：/config
Mode	String	否	- 示例值：hostPath

ConfigRelease

配置项发布信息

被如下接口引用：DescribeConfigReleases, DescribeGroupRelease, DescribePublicConfigReleases, ReleaseConfigWithDetailResp。

名称	类型	描述
ConfigReleaseId	String	配置项发布ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：dcfgr-egvkp4yo
ConfigId	String	配置项ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：dcfg-9ov6lpv3
ConfigName	String	配置项名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：app_config
ConfigVersion	String	配置项版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：v1
ReleaseTime	String	发布时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-11-28 18:51:06
GroupId	String	部署组ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：group-qevjzabd
GroupName	String	部署组名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：group_app
NamespaceId	String	命名空间ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：namespace-96a79v5b
NamespaceName	String	命名空间名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：ns_name
ClusterId	String	集群ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：cluster-2vz3nd3a
ClusterName	String	集群名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：cls_name
ReleaseDesc	String	发布描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：This is desc
ApplicationId	String	应用ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：application-l6ymbvgd
ConfigCenters	Array of TsfConfigCenter	配置中心发布情况 注意：此字段可能返回 null，表示取不到有效值。 示例值：[{"ConfigType":"EXCLUSIVE","ConfigCenterInstanceId":"ins-f4f48f71","ConfigCenterInstanceName":"pk-gz","RegionId":"33","CurrentVersion":"1.18.0.2","TargetVersion":"1.18.0.1"}]
DaulStatus	String	DUAL_STATUS_WRITE_REGISTRATION_ON 双写&&双注册开启 DUAL_STATUS_WRITE_REGISTRATION_OFF 双写&&双注册关闭 注意：此字段可能返回 null，表示取不到有效值。 示例值：DUAL_STATUS_WRITE_REGISTRATION_ON

ConfigReleaseLog

配置项发布日志

被如下接口引用：DescribeConfigReleaseLogs, DescribePublicConfigReleaseLogs。

名称	类型	描述
ConfigReleaseLogId	String	配置项发布日志ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：dcfgrl-5zvwk9v8
ConfigId	String	配置项ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：dcfg-m2vzp8yp
ConfigName	String	配置项名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：config_app
ConfigVersion	String	配置项版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：v1
GroupId	String	部署组ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：group-l9ynzydj
GroupName	String	部署组名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：group_app
NamespaceId	String	命名空间ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：namespace-96a79v5b
NamespaceName	String	命名空间名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：ns_app
ClusterId	String	集群ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：cluster-a2lgh1u2
ClusterName	String	集群名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：cls_app
ReleaseTime	String	发布时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-11-04 19:48:02
ReleaseDesc	String	发布描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：This is desc
ReleaseStatus	String	发布状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：S
LastConfigId	String	上次发布的配置项ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：dcfg-m2vzp8yp
LastConfigName	String	上次发布的配置项名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：config_app
LastConfigVersion	String	上次发布的配置项版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：v1
RollbackFlag	Boolean	回滚标识 注意：此字段可能返回 null，表示取不到有效值。 示例值：true
ReleasedConfigCenter	String	发布成功的配置中心 ALL/EXCLUSIVE/SHARE/NONE 全部发布成功，独占发布成功，共享发布成功，全部发布失败 注意：此字段可能返回 null，表示取不到有效值。 示例值：NONE

ConfigTemplate

配置模板对象

被如下接口引用：CreateConfigTemplateWithDetailResp, DescribeConfigTemplate。

名称	类型	必选	描述
ConfigTemplateId	String	否	配置模板Id 注意：此字段可能返回 null，表示取不到有效值。 示例值：dcfg_temp-vjmozkgv
ConfigTemplateName	String	否	配置模板名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：template-ribbon
ConfigTemplateDesc	String	否	配置模板描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：This is desc
ConfigTemplateType	String	否	配置模板对应的微服务框架 注意：此字段可能返回 null，表示取不到有效值。 示例值：Ribbon
ConfigTemplateValue	String	否	配置模板数据 注意：此字段可能返回 null，表示取不到有效值。 示例值：#请求处理超时时间\nribbon.ReadTimeout: 5000\n#请求连接超时时间\nribbon.ConnectTimeout: 2000\n#同一实例最大重试次数，不包括首次调用\nribbon.MaxAutoRetries: 0\n#重试其他实例的最大重试次数，不包括首次所选的server\nribbon.MaxAutoRetriesNextServer: 1\n#是否对所有操作请求都进行重试\nribbon.OkToRetryOnAllOperations: false\n
CreateTime	String	否	创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-12-20 17:01:51
UpdateTime	String	否	更新时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-12-20 17:01:51

ContainGroup

部署组列表（应用下钻界面的）

被如下接口引用：DescribeContainerGroups。

名称	类型	描述
GroupId	String	部署组ID 示例值：group-6a79x94v
GroupName	String	分组名称 示例值：group-mock
CreateTime	String	创建时间 示例值：2020-11-23 09:32:12
Server	String	镜像server 示例值：ccr.tencent.com
RepoName	String	镜像名，如/tsf/nginx 示例值：/tsf/nginx
TagName	String	镜像版本名称 示例值：latest
ClusterId	String	集群ID 示例值：cls-6a79x94v
ClusterName	String	集群名称 示例值：k8s-cls
NamespaceId	String	命名空间ID 示例值：namespace-6a79x94v
NamespaceName	String	命名空间名称 示例值：default
CpuRequest	String	初始分配的 CPU 核数，对应 K8S request 示例值：0.5
CpuLimit	String	最大分配的 CPU 核数，对应 K8S limit 示例值：1
MemRequest	String	初始分配的内存 MiB 数，对应 K8S request 示例值：128
MemLimit	String	最大分配的内存 MiB 数，对应 K8S limit 示例值：512
Alias	String	部署组备注 示例值：group-alias
KubeInjectEnable	Boolean	KubeInjectEnable值 示例值：false
UpdatedTime	String	更新时间 示例值：1528303820

ContainGroupResult

部署组列表（应用下钻）

被如下接口引用：DescribeContainerGroups。

名称	类型	描述
Content	Array of ContainGroup	部署组列表
TotalCount	Integer	总记录数 示例值：10

ContainerAdditionalResourceRequirement

应用使用容器部署时需要的额外资源

被如下接口引用：DescribeResourceConfig。

名称	类型	描述
Cpu	String	CPU 核数 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
Mem	String	内存 MiB 数 注意：此字段可能返回 null，表示取不到有效值。 示例值：1024

ContainerAdditionalResourceRequirementMap

不同类型的应用的容器部署组，部署时的额外资源要求

被如下接口引用：DescribeResourceConfig。

名称	类型	描述
M	ContainerAdditionalResourceRequirement	Mesh 应用部署时需要的额外资源 注意：此字段可能返回 null，表示取不到有效值。
N	ContainerAdditionalResourceRequirement	普通应用部署时需要的额外资源 注意：此字段可能返回 null，表示取不到有效值。

ContainerEvent

返回容器的事件，比如 k8s deployment 或者 pod 的 events

被如下接口引用：DescribeContainerEvents。

名称	类型	描述
FirstTimestamp	Integer	第一次出现的时间，以 ms 为单位的时间戳 示例值：1615463411385
LastTimestamp	Integer	最后一次出现的时间，以 ms 为单位的时间戳 示例值：1615463411385
Type	String	级别 示例值：Warning
Kind	String	Kubernetes 资源类型，典型取值有 Deployment(部署资源)、Pod(容器组)、Service(服务资源) 等 示例值：Pod
Name	String	资源名称 示例值：shop-demo-7ff965d54d-65rlw.1668ccf6e4263fde
Reason	String	内容 示例值：Pulled
Message	String	详细描述 示例值：0/1 nodes are available: 1 Insufficient memory.
Count	Integer	出现次数 示例值：3

ContainerGroupDeploy

获取部署组

被如下接口引用：DescribeContainerGroupDeployInfo。

名称	类型	描述
GroupId	String	部署组id 示例值：group-6a79x94v
GroupName	String	分组名称 示例值：user-group
InstanceNum	Integer	实例总数 示例值：2
CurrentNum	Integer	已启动实例总数 示例值：2
Server	String	镜像server 注意：此字段可能返回 null，表示取不到有效值。 示例值：ccr.tencent.com
Reponame	String	镜像名，如/tsf/nginx 注意：此字段可能返回 null，表示取不到有效值。 示例值：/tsf/nginx
TagName	String	镜像版本名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：latest
CpuRequest	String	业务容器初始分配的 CPU 核数，对应 K8S request 注意：此字段可能返回 null，表示取不到有效值。 示例值：0.5
CpuLimit	String	业务容器最大分配的 CPU 核数，对应 K8S limit 注意：此字段可能返回 null，表示取不到有效值。 示例值：2
MemRequest	String	业务容器初始分配的内存 MiB 数，对应 K8S request 注意：此字段可能返回 null，表示取不到有效值。 示例值：32
MemLimit	String	业务容器最大分配的内存 MiB 数，对应 K8S limit 注意：此字段可能返回 null，表示取不到有效值。 示例值：64
AccessType	Integer	0:公网 1:集群内访问 2：NodePort 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
ProtocolPorts	Array of ProtocolPort	端口映射
UpdateType	Integer	更新方式：0:快速更新 1:滚动更新 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
UpdateIvl	Integer	更新间隔,单位秒 注意：此字段可能返回 null，表示取不到有效值。 示例值：30
JvmOpts	String	jvm参数 注意：此字段可能返回 null，表示取不到有效值。 示例值：-Xms32m
SubnetId	String	子网id 注意：此字段可能返回 null，表示取不到有效值。 示例值：subnet-6a79x94v
AgentCpuRequest	String	agent容器初始分配的 CPU 核数，对应 K8S request 注意：此字段可能返回 null，表示取不到有效值。 示例值：0.1
AgentCpuLimit	String	agent容器最大分配的 CPU 核数，对应 K8S limit 注意：此字段可能返回 null，表示取不到有效值。 示例值：0.2
AgentMemRequest	String	agent容器初始分配的内存 MiB 数，对应 K8S request 注意：此字段可能返回 null，表示取不到有效值。 示例值：32
AgentMemLimit	String	agent容器最大分配的内存 MiB 数，对应 K8S limit 注意：此字段可能返回 null，表示取不到有效值。 示例值：32
IstioCpuRequest	String	istioproxy容器初始分配的 CPU 核数，对应 K8S request 注意：此字段可能返回 null，表示取不到有效值。 示例值：0.1
IstioCpuLimit	String	istioproxy容器最大分配的 CPU 核数，对应 K8S limit 注意：此字段可能返回 null，表示取不到有效值。 示例值：0.2
IstioMemRequest	String	istioproxy容器初始分配的内存 MiB 数，对应 K8S request 注意：此字段可能返回 null，表示取不到有效值。 示例值：32
IstioMemLimit	String	istioproxy容器最大分配的内存 MiB 数，对应 K8S limit 注意：此字段可能返回 null，表示取不到有效值。 示例值：32
Envs	Array of Env	部署组的环境变量数组，这里没有展示 tsf 使用的环境变量，只展示了用户设置的环境变量。 注意：此字段可能返回 null，表示取不到有效值。
HealthCheckSettings	HealthCheckSettings	健康检查配置信息，若不指定该参数，则默认不设置健康检查。 注意：此字段可能返回 null，表示取不到有效值。
DeployAgent	Boolean	是否部署Agent容器 示例值：true
Alias	String	部署组备注 注意：此字段可能返回 null，表示取不到有效值。 示例值：group-alias
DisableService	Boolean	是否创建 k8s service 示例值：false
HeadlessService	Boolean	service 是否为 headless 类型 示例值：false
TcrRepoInfo	TcrRepoInfo	TcrRepoInfo值 注意：此字段可能返回 null，表示取不到有效值。
VolumeInfos	Array of VolumeInfo	数据卷信息，数组结构 注意：此字段可能返回 null，表示取不到有效值。
VolumeMountInfos	Array of VolumeMountInfo	数据卷挂载信息，list 注意：此字段可能返回 null，表示取不到有效值。
KubeInjectEnable	Boolean	KubeInjectEnable值 注意：此字段可能返回 null，表示取不到有效值。 示例值：false
RepoType	String	仓库类型 (person, tcr) 示例值：personal
WarmupSetting	WarmupSetting	预热配置设置
GatewayConfig	GatewayConfig	Envoy网关服务配置 注意：此字段可能返回 null，表示取不到有效值。
ContainerName	String	容器名称 示例值：java-service-xn28103-92sjx8
AdditionalContainerList	Array of GroupContainerInfo	附加容器列表
InternalContainerList	Array of GroupContainerInfo	内部容器列表
ServiceSettingList	Array of ServiceSetting	service列表

ContainerGroupDetail

容器部署组详情

被如下接口引用：DescribeContainerGroupDetail。

名称	类型	描述
GroupId	String	部署组ID 示例值：group-6a79x94v
GroupName	String	分组名称 示例值：java-group
InstanceNum	Integer	实例总数 注意：此字段可能返回 null，表示取不到有效值。 示例值：2
CurrentNum	Integer	已启动实例总数 示例值：2
CreateTime	String	创建时间 示例值：2020-11-21 09:33:23
Server	String	镜像server 注意：此字段可能返回 null，表示取不到有效值。 示例值：ccr.tencent.com
Reponame	String	镜像名，如/tsf/nginx 注意：此字段可能返回 null，表示取不到有效值。 示例值：/tsf/nginx
TagName	String	镜像版本名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：latest
ClusterId	String	集群ID 示例值：cls-6a79x94v
ClusterName	String	集群名称 示例值：k8s-cls
NamespaceId	String	命名空间ID 示例值：namespace-6a79x94v
NamespaceName	String	命名空间名称 示例值：default
ApplicationId	String	应用ID 示例值：application-6a79x94v
LbIp	String	负载均衡ip 示例值：10.20.13.1
ApplicationType	String	应用类型 示例值：C
ClusterIp	String	Service ip 示例值：10.19.102.1
NodePort	Integer	NodePort端口，只有公网和NodePort访问方式才有值 注意：此字段可能返回 null，表示取不到有效值。 示例值：30021
CpuLimit	String	最大分配的 CPU 核数，对应 K8S limit 注意：此字段可能返回 null，表示取不到有效值。 示例值：2
MemLimit	String	最大分配的内存 MiB 数，对应 K8S limit 注意：此字段可能返回 null，表示取不到有效值。 示例值：256
AccessType	Integer	0:公网 1:集群内访问 2：NodePort 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
UpdateType	Integer	更新方式：0:快速更新 1:滚动更新 示例值：1
UpdateIvl	Integer	更新间隔,单位秒 注意：此字段可能返回 null，表示取不到有效值。 示例值：30
ProtocolPorts	Array of ProtocolPort	端口数组对象
Envs	Array of Env	环境变量数组对象
ApplicationName	String	应用名称 示例值：java-service
Message	String	pod错误信息描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：this is a msg
Status	String	部署组状态 示例值：Running
MicroserviceType	String	服务类型 示例值：DEF
CpuRequest	String	初始分配的 CPU 核数，对应 K8S request 注意：此字段可能返回 null，表示取不到有效值。 示例值：0.5
MemRequest	String	初始分配的内存 MiB 数，对应 K8S request 注意：此字段可能返回 null，表示取不到有效值。 示例值：128
SubnetId	String	子网id 注意：此字段可能返回 null，表示取不到有效值。 示例值：subnet-6a79x94v
GroupResourceType	String	部署组资源类型 示例值：C
InstanceCount	Integer	部署组实例个数 示例值：4
UpdatedTime	Integer	部署组更新时间戳 示例值：1762890382
MaxSurge	String	kubernetes滚动更新策略的MaxSurge参数 注意：此字段可能返回 null，表示取不到有效值。 示例值：25%
MaxUnavailable	String	kubernetes滚动更新策略的MaxUnavailable参数 注意：此字段可能返回 null，表示取不到有效值。 示例值：25%
HealthCheckSettings	HealthCheckSettings	部署组健康检查设置 注意：此字段可能返回 null，表示取不到有效值。
AllowPlainYamlDeploy	Boolean	允许PlainYamlDeploy 示例值：true
IsNotEqualServiceConfig	Boolean	是否不等于ServiceConfig 注意：此字段可能返回 null，表示取不到有效值。 示例值：true
RepoName	String	仓库名 注意：此字段可能返回 null，表示取不到有效值。 示例值：/tsf/nginx
Alias	String	别名 注意：此字段可能返回 null，表示取不到有效值。 示例值：group-alias

ContainerGroupObservabilityConfig

可观测配置

被如下接口引用：DeployContainerApplication。

名称	类型	必选	描述
BusinessLogConfigIdList	Array of String	否	日志配置项ID列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：["apm-busi-log-cfg-lba2povk", "apm-busi-log-cfg-2vz5nm9v"]
BusinessLogDeliveryConfigIdList	Array of String	否	投递配置项ID列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：["send-data-to-kafka-nyg9o3wa"]

ContainerGroupOther

部署组列表-其它字段

被如下接口引用：DescribeContainerGroupAttribute。

名称	类型	描述
InstanceNum	Integer	实例总数 示例值：3
CurrentNum	Integer	已启动实例总数 示例值：3
LbDns	String	负载均衡DNS地址 示例值：dns.com
LbIp	String	负载均衡ip 示例值：10.2.3.4
ClusterIp	String	Service ip 示例值：10.3.2.1
Status	String	服务状态，请参考后面的状态定义 示例值：Running
Message	String	服务状态，请参考后面的状态定义 示例值：this is a msg
Envs	Array of Env	环境变量
NodePort	Integer	Service NodePort 注意：此字段可能返回 null，表示取不到有效值。 示例值：30111
SubnetId	String	子网ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：subnet-2j9sh3
HealthCheckSettings	HealthCheckSettings	健康检查相关字段 注意：此字段可能返回 null，表示取不到有效值。
IsNotEqualServiceConfig	Boolean	服务配置信息是否匹配 示例值：false

ContainerGroupResourceConfig

容器部署组相关的参数配置

被如下接口引用：DescribeResourceConfig。

名称	类型	描述
AdditionalResourceRequirement	ContainerAdditionalResourceRequirementMap	不同类型的应用的容器部署组，部署时的额外资源要求 注意：此字段可能返回 null，表示取不到有效值。

ContainerGroupServiceGovernanceConfig

服务治理相关配置项

被如下接口引用：DeployContainerApplication。

名称	类型	必选	描述
EnableGovernance	Boolean	否	是否开启服务治理 注意：此字段可能返回 null，表示取不到有效值。 示例值：true
ServiceConfigList	Array of ServiceConfig	否	控制台场景使用 mesh服务配置信息列表 注意：此字段可能返回 null，表示取不到有效值。
ExclusiveInstances	Array of ExclusiveInstance	否	注册服务治理实例 注意：此字段可能返回 null，表示取不到有效值。
GovernanceType	String	否	服务治理类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：SHARE

ContainerInfo

容器详细信息

被如下接口引用：DeployContainerApplication。

名称	类型	必选	描述
Name	String	否	容器名 注意：此字段可能返回 null，表示取不到有效值。 示例值：consumer
ContainerId	String	否	容器ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：0f675d42546fc
Status	String	否	容器状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：Waiting
Reason	String	否	容器的Reason 注意：此字段可能返回 null，表示取不到有效值。 示例值：ContainerCreating
Image	String	否	镜像地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：ccr.ccs.tencentyun.com/tsf_700001067584/test-ns
IsBusinessMainContainer	Boolean	否	是否为业务主容器 注意：此字段可能返回 null，表示取不到有效值。 示例值：true
Server	String	否	镜像Server 注意：此字段可能返回 null，表示取不到有效值。 示例值：ccr.ccs.tencentyun.com
RepoName	String	否	镜像名 注意：此字段可能返回 null，表示取不到有效值。 示例值：tsf_700001067584/test-ns
RepoType	String	否	仓库类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：personal
TcrRepoInfo	TcrRepoInfo	否	TCR 仓库信息 注意：此字段可能返回 null，表示取不到有效值。
SecretName	String	否	容器访问凭证名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：qcloudregistry
TagName	String	否	镜像版本号 注意：此字段可能返回 null，表示取不到有效值。 示例值：v1
HealthCheckSettings	HealthCheckSettings	否	健康检查 注意：此字段可能返回 null，表示取不到有效值。
CpuRequest	String	否	容器Cpu request 注意：此字段可能返回 null，表示取不到有效值。 示例值：0.25
CpuLimit	String	否	容器Cpu limit 注意：此字段可能返回 null，表示取不到有效值。 示例值：0.5
MemRequest	String	否	容器Mem request 注意：此字段可能返回 null，表示取不到有效值。 示例值：120
MemLimit	String	否	容器Mem Limit 注意：此字段可能返回 null，表示取不到有效值。 示例值：1280
Envs	Array of Env	否	环境变量参数 注意：此字段可能返回 null，表示取不到有效值。
UserEnvs	Array of Env	否	环境变量参数 注意：此字段可能返回 null，表示取不到有效值。
JvmOpts	String	否	JVM参数 注意：此字段可能返回 null，表示取不到有效值。 示例值：-Xms128m -Xmx512m -XX:MetaspaceSize=128m -XX:MaxMetaspaceSize=512m
VolumeMountInfoList	Array of VolumeMountInfo	否	挂载信息 注意：此字段可能返回 null，表示取不到有效值。
InitContainerEnable	Boolean	否	是否为初始化容器 注意：此字段可能返回 null，表示取不到有效值。 示例值：false
LifeCycleHookList	Array of LifeCycleHook	否	生命周期钩子 注意：此字段可能返回 null，表示取不到有效值。
PrivilegeContainerEnable	Boolean	否	是否为特权容器 注意：此字段可能返回 null，表示取不到有效值。 示例值：false
RunCommand	String	否	运行命令 注意：此字段可能返回 null，表示取不到有效值。 示例值：/bin/sh
RunArg	String	否	运行参数 注意：此字段可能返回 null，表示取不到有效值。 示例值：-c\nwhile true; do echo hello; sleep 10; done
ContainerName	String	否	容器名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：group-nygeogpv-docker

ContainerInstanceResourceConfig

容器实例相关的参数配置

被如下接口引用：DescribeResourceConfig。

名称	类型	描述
ImportMode	Array of String	实例导入方式，可多个，公有云为 ["R"]，独立版的取值有 "M" 脚本模式、"S" SSH 模式 注意：此字段可能返回 null，表示取不到有效值。 示例值：["R"]
MasterNumLimit	Integer	SSH 模式时，前端应该限制用户填这个数量的 master 主机信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
NodeNumLimitPerSetup	Integer	SSH 模式时，前端应该限制用户填的最高数量的 node 主机信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：1

CosCredentials

cos临时账号信息

被如下接口引用：DescribeDownloadInfo, DescribeUploadInfo。

名称	类型	必选	描述
SessionToken	String	否	会话Token 示例值：session-token-xxxxxxxxxxxxxx
TmpAppId	String	否	临时应用ID 示例值：tapp-6a79x94v
TmpSecretId	String	否	临时调用者身份ID 示例值：si-xxxxxxxxxxxxxxxxxxxxxxxxxxxx
TmpSecretKey	String	否	临时密钥 示例值：sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
ExpiredTime	Integer	否	过期时间 示例值：18262938379
Domain	String	否	所在域 示例值：gz

CosDownloadInfo

Cos下载所需信息

被如下接口引用：DescribeDownloadInfo。

名称	类型	描述
Bucket	String	桶名称 示例值：tsf_bucket
Region	String	地域 示例值：ap-guangzhou
Path	String	路径 示例值：/tsf
Credentials	CosCredentials	鉴权信息

CosUploadInfo

cos上传所需信息

被如下接口引用：DescribeUploadInfo。

名称	类型	必选	描述
PkgId	String	否	程序包ID 示例值：pkg-6a79x94v
Bucket	String	否	桶 示例值：tsf_bucket
Region	String	否	目标地域 示例值：ap-guangzhou
Path	String	否	存储路径 示例值：/tsf
Credentials	CosCredentials	否	鉴权信息

CurvePoint

构成监控数据图的曲线坐标点

被如下接口引用：DescribeJvmMonitor。

名称	类型	描述
Label	String	当前坐标 X轴的值 当前是日期格式:"yyyy-MM-dd HH:mm:ss" 示例值：host
Value	String	当前坐标 Y轴的值 示例值：hostName
Timestamp	String	该坐标点时间戳，单位毫秒 示例值：1754555818541

CustomPodSchedule

自定义Pod调度规则

被如下接口引用：DeployContainerApplication, DeployContainerGroup。

名称	类型	必选	描述
ForceSchedule	ForceSchedule	否	-
TrySchedule	TrySchedule	否	-

CustomTolerateSchedule

自定义容忍调度规则列表

被如下接口引用：DeployContainerApplication, DeployContainerGroup。

名称	类型	必选	描述
Key	String	否	- 示例值：host
Operator	String	否	- 示例值：equlas
Value	String	否	- 示例值：hostName
Effect	String	否	- 示例值：effect
TolerationSeconds	Integer	否	- 示例值：30

DeleteImageTag

需要删除的镜像版本

被如下接口引用：DeleteImageTags。

名称	类型	必选	描述
RepoName	String	是	仓库名，如/tsf/nginx 示例值：/tsf/nginx
TagName	String	是	版本号:如V1 示例值：latest

DeliveryConfigBindGroup

描述投递配置项绑定的部署组

被如下接口引用：DescribeDeliveryConfigs。

名称	类型	必选	描述
ConfigId	String	是	配置id 示例值：config-6a79x94v
ConfigName	String	是	配置名 示例值：send-kafka-config
CollectPath	Array of String	是	采集路径 示例值：["/var/log"]
Groups	Array of GroupInfo	是	关联部署组信息
CreateTime	String	是	创建时间，格式yyyy-MM-dd HH:mm:ss 示例值：2020-11-22 09:27:12
KafkaVIp	String	否	Kafka的vip 注意：此字段可能返回 null，表示取不到有效值。 示例值：10.23.2.1
KafkaAddress	String	否	Kafka地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：kafka.tencent.com
KafkaVPort	String	否	Kafka端口 注意：此字段可能返回 null，表示取不到有效值。 示例值：8080
Topic	String	否	Topic 示例值：LOG_TOPIC
LineRule	String	否	LineRule 注意：此字段可能返回 null，表示取不到有效值。 示例值：.*
CustomRule	String	否	自定义规则 注意：此字段可能返回 null，表示取不到有效值。 示例值：.*
EnableGlobalLineRule	Boolean	否	EnableGlobalLineRule 注意：此字段可能返回 null，表示取不到有效值。 示例值：true
EnableAuth	Boolean	否	是否开启认证 示例值：false
Username	String	否	用户名 注意：此字段可能返回 null，表示取不到有效值。 示例值：root
Password	String	否	密码 注意：此字段可能返回 null，表示取不到有效值。 示例值：pass-xxxxxx
KafkaInfos	Array of DeliveryKafkaInfo	否	KafkaInfos 注意：此字段可能返回 null，表示取不到有效值。

DeliveryConfigBindGroups

描述配置项绑定的部署组

被如下接口引用：DescribeDeliveryConfigs。

名称	类型	描述
TotalCount	Integer	公共条数 示例值：21
Content	Array of DeliveryConfigBindGroup	内容

DeliveryKafkaInfo

kafka投递的topic和path的信息

被如下接口引用：DescribeDeliveryConfig, DescribeDeliveryConfigs。

名称	类型	必选	描述
Topic	String	否	投递kafka的topic 示例值：SEND_KAFKA_TOPIC
Path	Array of String	否	采集日志的path 示例值：/var/log
LineRule	String	否	default，默认换行符分行 time，按时间分行 custom, 选了custom那么CustomRule就要填入具体的自定义值 示例值：.*
CustomRule	String	否	自定义的分行值 示例值：.*

DeployContainerApplicationResp

部署后返回的结构体

被如下接口引用：DeployContainerApplication。

名称	类型	描述
GroupId	String	部署组ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：group-zvwpn3wy
TaskId	String	任务ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：task-2.0-2vz683oa

DescribeResourceConfigCluster

返回给前端的控制信息

被如下接口引用：DescribeResourceConfig。

名称	类型	描述
Container	DescribeResourceConfigClusterContainer	返回给前端的控制信息 注意：此字段可能返回 null，表示取不到有效值。

DescribeResourceConfigClusterContainer

返回给前端的控制信息

被如下接口引用：DescribeResourceConfig。

名称	类型	描述
NeedSubnetWhenCreatingCluster	Boolean	是否需要子网 注意：此字段可能返回 null，表示取不到有效值。 示例值：true

DescribeResourceConfigLicense

DescribeResourceConfig

被如下接口引用：DescribeResourceConfig。

名称	类型	描述
Function	Array of DescribeResourceConfigLicenseFunction	功能 注意：此字段可能返回 null，表示取不到有效值。
Resource	Array of DescribeResourceConfigLicenseResource	资源 注意：此字段可能返回 null，表示取不到有效值。
ExpireTime	Integer	utc时间 单位秒 注意：此字段可能返回 null，表示取不到有效值。 示例值：10
Countdown	Integer	utc时间 单位秒 注意：此字段可能返回 null，表示取不到有效值。 示例值：10
Spec	String	规格 注意：此字段可能返回 null，表示取不到有效值。 示例值：basic

DescribeResourceConfigLicenseFunction

DescribeResourceConfig

被如下接口引用：DescribeResourceConfig。

名称	类型	描述
Name	String	功能名 注意：此字段可能返回 null，表示取不到有效值。 示例值：vm
Enable	Boolean	是否启用 注意：此字段可能返回 null，表示取不到有效值。 示例值：true

DescribeResourceConfigLicenseResource

DescribeResourceConfig

被如下接口引用：DescribeResourceConfig。

名称	类型	描述
Name	String	Name 注意：此字段可能返回 null，表示取不到有效值。 示例值：instance
Quota	Integer	Quota 注意：此字段可能返回 null，表示取不到有效值。 示例值：1

DescribeResourceConfigResultV2

DescribeResourceConfig

被如下接口引用：DescribeResourceConfig。

名称	类型	描述
Sts	DescribeResourceConfigSts	STS参数配置 注意：此字段可能返回 null，表示取不到有效值。
License	DescribeResourceConfigLicense	许可信息 注意：此字段可能返回 null，表示取不到有效值。
Group	GroupResourceConfig	部署组相关的参数配置 注意：此字段可能返回 null，表示取不到有效值。
Instance	InstanceResourceConfig	实例相关的参数配置 注意：此字段可能返回 null，表示取不到有效值。
Cluster	DescribeResourceConfigCluster	Cluster相关配置信息 注意：此字段可能返回 null，表示取不到有效值。
Package	PackageConfig	程序包相关配置信息 注意：此字段可能返回 null，表示取不到有效值。

DescribeResourceConfigSts

DescribeResourceConfig

被如下接口引用：DescribeResourceConfig。

名称	类型	描述
Uin	String	uin 注意：此字段可能返回 null，表示取不到有效值。 示例值：91000000039

EmptyDirOption

空目录选项

被如下接口引用：DeployContainerApplication, DeployContainerGroup, DescribeContainerGroupDeployInfo。

名称	类型	必选	描述
EnableMemory	Boolean	否	- 示例值：false
StorageCapacity	Integer	否	- 示例值：64
StorageUnit	String	否	- 示例值：12
SizeLimit	String	否	- 示例值：32

Env

环境变量

被如下接口引用：DeployContainerApplication, DeployContainerGroup, DescribeContainerGroupAttribute, DescribeContainerGroupDeployInfo, DescribeContainerGroupDetail。

名称	类型	必选	描述
Name	String	是	环境变量名称 示例值：foo
Value	String	否	环境变量值 示例值：bar
ValueFrom	ValueFrom	否	k8s ValueFrom 注意：此字段可能返回 null，表示取不到有效值。

ExclusiveInstance

独占实例

被如下接口引用：CreateApplication, DeployContainerApplication, DescribeApplication, ModifyApplication。

名称	类型	必选	描述
CenterType	String	否	配置中心类型[注册中心Registration、配置中心Configuration] 示例值：Registration
InstanceId	String	否	实例id，通过北极星控制台获取 示例值：ins-6a79x94v
InstanceType	String	否	实例类型，例如北极星Polaris 示例值：Polaris
InstanceName	String	否	实例名称 示例值：Polaris-Config
RegionId	String	否	实例地域id，通过北极星控制台获取 示例值：7
InstanceNamespaceId	String	否	实例命名空间ID，通过北极星控制台获取 示例值：namespace-6a79x94v
GroupId	String	否	部署组Id 注意：此字段可能返回 null，表示取不到有效值。 示例值：group-6a73eg5v
CreateTime	Integer	否	创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1757324401000
UpdateTime	Integer	否	更新时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1757324863000

FieldRef

容器 env 的 FieldRef

被如下接口引用：DeployContainerApplication, DeployContainerGroup, DescribeContainerGroupDeployInfo。

名称	类型	必选	描述
FieldPath	String	否	k8s 的 FieldPath 示例值：metadata.name

FileConfig

文件配置项

被如下接口引用：CreateFileConfigWithDetailResp, DescribeFileConfigs。

名称	类型	必选	描述
ConfigId	String	否	配置项ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：dcfg-f-jqv3z9y7
ConfigName	String	否	配置项名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：app-config
ConfigVersion	String	否	配置项版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：v1.0
ConfigVersionDesc	String	否	配置项版本描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：This is desc
ConfigFileName	String	否	配置项文件名 注意：此字段可能返回 null，表示取不到有效值。 示例值：app.config
ConfigFileValue	String	否	配置项文件内容 注意：此字段可能返回 null，表示取不到有效值。 示例值：config=enabled
ConfigFileCode	String	否	配置项文件编码 注意：此字段可能返回 null，表示取不到有效值。 示例值：utf-8
CreationTime	String	否	创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-12-20 17:27:44
ApplicationId	String	否	配置项归属应用ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：application-l6ymbvgd
ApplicationName	String	否	应用名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：provider-app
DeleteFlag	Boolean	否	删除标识 注意：此字段可能返回 null，表示取不到有效值。 示例值：true
ConfigVersionCount	Integer	否	配置项版本数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
LastUpdateTime	String	否	配置项最后更新时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-12-20 17:27:44
ConfigFilePath	String	否	发布路径 注意：此字段可能返回 null，表示取不到有效值。 示例值：/root
ConfigPostCmd	String	否	后置命令 注意：此字段可能返回 null，表示取不到有效值。 示例值：/usr/bin/bash
ConfigFileValueLength	Integer	否	配置项文件长度 注意：此字段可能返回 null，表示取不到有效值。 示例值：14

FileConfigRelease

文件配置项发布信息

被如下接口引用：DescribeFileConfigReleases, DescribeGroupRelease。

名称	类型	描述
ConfigReleaseId	String	配置项发布ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：dcfgr-egvkp4yo
ConfigId	String	配置项ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：dcfg-9ov6lpv3
ConfigName	String	配置项名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：config_app
ConfigVersion	String	配置项版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：v1
ReleaseDesc	String	发布描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：This is desc
ReleaseTime	String	发布时间。格式为 YYYY-MM-DD hh:mm:ss。 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-11-28 18:51:06
GroupId	String	部署组ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：group-qevjzabd
GroupName	String	部署组名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：group_app
NamespaceId	String	命名空间ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：namespace-96a79v5b
NamespaceName	String	命名空间名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：ns_app
ClusterId	String	集群ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：cluster-mjy9mvgz
ClusterName	String	集群名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：cls_app
ConfigCenters	Array of TsfConfigCenter	配置中心发布详情 注意：此字段可能返回 null，表示取不到有效值。

Filter

用于请求参数中的条件过滤字段

被如下接口引用：DescribeInstances, DescribeMicroservice。

名称	类型	必选	描述
Name	String	是	过滤条件名 示例值：host
Values	Array of String	是	过滤条件匹配值，几个条件间是或关系 示例值：["metadata.host"]

ForceSchedule

强制调度配置

被如下接口引用：DeployContainerApplication, DeployContainerGroup。

名称	类型	必选	描述
AffinityList	Array of Affinity	否	-
AntiAffinityList	Array of Affinity	否	-

GatewayApiGroupVo

网关分组简单信息

被如下接口引用：DescribeGatewayAllGroupApis。

名称	类型	描述
GroupId	String	分组ID 示例值：grp-vcgimq3x
GroupName	String	分组名称 示例值：testGroup1
GroupApiCount	Integer	分组下API个数 示例值：22
GroupApis	Array of GatewayGroupApiVo	分组API列表
GatewayInstanceType	String	网关实例的类型 示例值：unit
GatewayInstanceId	String	网关实例ID 示例值：gw-ins-4hkjbwxy

GatewayConfig

TSF Envoy网关服务配置

被如下接口引用：DescribeContainerGroupDeployInfo, DescribeGroup。

名称	类型	必选	描述
Name	String	是	服务名称 示例值：envoy-gateway

GatewayDeployGroup

api分组已绑定的网关部署组

被如下接口引用：DescribeApiGroup, DescribeApiGroups, DescribeGroupBindedGateways, DescribeGroupGateways, DescribeGroupsWithPlugin。

名称	类型	描述
DeployGroupId	String	网关部署组ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：group-xoydmy26
DeployGroupName	String	网关部署组名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：group_app
ApplicationId	String	应用ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：application-l6ymbvgd
ApplicationName	String	应用名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：app_provider
ApplicationType	String	应用分类：V：虚拟机应用，C：容器应用 注意：此字段可能返回 null，表示取不到有效值。 示例值：C
GroupStatus	String	部署组应用状态,取值: Running、Waiting、Paused、Updating、RollingBack、Abnormal、Unknown 注意：此字段可能返回 null，表示取不到有效值。 示例值：released
ClusterType	String	集群类型，C ：容器，V：虚拟机 注意：此字段可能返回 null，表示取不到有效值。 示例值：C

GatewayGroupApiVo

网关API简单信息

被如下接口引用：DescribeGatewayAllGroupApis。

名称	类型	必选	描述
ApiId	String	否	API ID 示例值：api-sadasf
Path	String	否	API 请求路径 示例值：/test/echo/xxx
MicroserviceName	String	否	API 微服务名称 示例值：ms1
Method	String	否	API 请求方法 注意：此字段可能返回 null，表示取不到有效值。 示例值：GET
NamespaceName	String	否	命名空间名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：ns-test

GatewayGroupIds

网关部署组ID和网关API分组ID元组

被如下接口引用：BindApiGroup, UnbindApiGroup。

名称	类型	必选	描述
GatewayDeployGroupId	String	是	网关部署组ID 示例值：group-xoydmy26
GroupId	String	是	分组id 示例值：grp-57at58po

GatewayPlugin

微服务网关插件实例对象

被如下接口引用：DescribePluginInstances。

名称	类型	描述
Id	String	网关插件id 注意：此字段可能返回 null，表示取不到有效值。 示例值：pgn-004mb1lw
Name	String	插件名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：plugin_tag
Type	String	插件类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：Tag
Description	String	插件描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：This is desc
CreatedTime	String	创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-12-19 21:00:00
UpdatedTime	String	更新时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-12-19 21:00:00
Status	String	发布状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：released
DeleteDisabled	Boolean	是否禁用删除 示例值：true
DeleteDisabledReason	String	禁用原因 示例值：已存在绑定资源,请解绑分组或API后重试

GatewayPluginBoundParam

微服务网关插件绑定对象

被如下接口引用：BindPlugin。

名称	类型	必选	描述
PluginId	String	是	插件id 示例值：pgn-ete4dvco
ScopeType	String	是	插件绑定到的对象类型:group/api/all 示例值：group
ScopeValue	String	是	插件绑定到的对象主键值，例如分组的ID/API的ID 示例值：grp-y7j1qhk3
MicroserviceId	String	否	创建关联的服务id，关联envoy网关时使用 示例值：ms-by8o5kgv
GatewayInstanceId	String	否	网关id 示例值：gw-ins-anrptnkf

GatewayVo

网关部署组、分组、API列表数据

被如下接口引用：DescribeGatewayAllGroupApis。

名称	类型	描述
GatewayDeployGroupId	String	网关部署组ID 示例值：gw-e42d597
GatewayDeployGroupName	String	网关部署组名称 示例值：scg-container-test
GroupNum	Integer	API 分组个数 示例值：10
Groups	Array of GatewayApiGroupVo	API 分组列表

GroupApiUseStatistics

API监控明细数据

被如下接口引用：DescribeApiUseDetail。

名称	类型	描述
TopStatusCode	Array of ApiUseStatisticsEntity	总调用数 示例值：[{"Count":"31195155","Name":"4xx","Ratio":"0.9475155245827801"},{"Count":"1727952","Name":"2xx","Ratio":"0.052484475417219886"}]
TopTimeCost	Array of ApiUseStatisticsEntity	平均错误率 示例值：[{"Count":"27774834","Name":"0_100_ms","Ratio":"0.8436273648170569"},{"Count":"2719351","Name":"100_200_ms","Ratio":"0.08259703435644758"}]
Quantile	QuantileEntity	分位值对象 示例值：{"FifthPositionValue":"177.60000","MaxValue":"260.92000","MinValue":"3.92000","NinthPositionValue":"251.99500"}

GroupContainerInfo

部署组容器信息

被如下接口引用：DescribeContainerGroupDeployInfo。

名称	类型	必选	描述
TagName	String	是	镜像版本名称 示例值：v1
ContainerName	String	否	容器名字 示例值：app
RepoName	String	否	镜像名 示例值：tsf/app
RepoType	String	否	仓库类型,tcr，address，personal，默认personal 示例值：personal
TcrRepoInfo	TcrRepoInfo	否	tcr仓库信息
Server	String	否	镜像server 示例值：ccr.ccs.tencentyun.com
SecretName	String	否	凭证名字 示例值：default-secret
JvmOpts	String	否	jvm 参数 示例值：-Xmx512m -Xms128m
CpuLimit	String	否	容器最大的 CPU 核数，对应 K8S 的 limit 示例值：2
CpuRequest	String	否	容器分配的 CPU 核数，对应 K8S 的 request 示例值：1
MemRequest	String	否	容器分配的内存 MiB 数，对应 K8S 的 request 示例值：1024
MemLimit	String	否	容器最大的内存 MiB 数，对应 K8S 的 limit 示例值：1024
HealthCheckSettings	HealthCheckSettings	否	健康检查配置信息
Envs	Array of Env	否	环境变量
UserEnvs	Array of Env	否	环境变量,作为入参时不用填
VolumeMountInfoList	Array of VolumeMountInfo	否	数据卷挂载点信息

GroupDailyUseStatistics

分组日使用统计对象

被如下接口引用：DescribeGroupUseDetail。

名称	类型	描述
TopReqAmount	Array of GroupUseStatisticsEntity	总调用数
TopFailureRate	Array of GroupUseStatisticsEntity	平均错误率
TopAvgTimeCost	Array of GroupUseStatisticsEntity	平均响应耗时

GroupInfo

日志投递kafka用，描述部署组信息

被如下接口引用：AssociateConfigWithGroup, DescribeDeliveryConfigs。

名称	类型	必选	描述
GroupId	String	是	部署组ID 可通过调用DescribeContainerGroups或DescribeGroups查询已创建的部署组列表或登录控制台进行查看。 示例值：group-6a79x94v
GroupName	String	是	部署组名称 示例值：group-demo
ClusterType	String	是	集群类型，C：容器集群，V：虚拟机集群 示例值：C
ClusterId	String	否	集群ID 可通过DescribeClusters查询已经创建的集群列表，也可以通过登录控制台查看。 示例值：cls-6a79x94v
ClusterName	String	否	集群名称 示例值：k8s-cls
NamespaceName	String	否	命名空间名称 示例值：my-namespace
AssociateTime	String	否	绑定时间，格式yyyy-MM-dd HH:mm:ss 示例值：2020-12-23 12:34:34

GroupPod

部署组实例列表

被如下接口引用：DescribePodInstances。

名称	类型	描述
PodName	String	实例名称(对应到kubernetes的pod名称) 示例值：app-2bs821-sb782ns
PodId	String	实例ID(对应到kubernetes的pod id) 示例值：app-2bs821-sb782ns
Status	String	实例状态，请参考后面的实例以及容器的状态定义。启动中（pod 未 ready）：Starting；运行中：Running；异常：Abnormal；停止：Stopped； 示例值：Running
Reason	String	实例处于当前状态的原因，例如容器下载镜像失败 示例值：null
NodeIp	String	主机IP 示例值：10.10.0.1
Ip	String	实例IP 示例值：10.10.0.2
RestartCount	Integer	实例中容器的重启次数 示例值：0
ReadyCount	Integer	实例中已就绪容器的个数 示例值：1
Runtime	String	运行时长，单位秒 示例值：126
CreatedAt	String	实例启动时的时间戳，单位秒 示例值：158702289
ServiceInstanceStatus	String	服务实例状态，枚举值为： - Starting：启动中 - Running：运行中 - Stopping：停止中 - Stopped: 已停止 - StopFailed: 停止失败 - Abnormal: 异常 - Unknown: 未知 示例值：RUNNING
InstanceAvailableStatus	String	机器实例可使用状态，枚举值为： - Starting：启动中 - Running：运行中 - Stopping：停止中 - Stopped: 已停止 - StopFailed: 停止失败 - Abnormal: 异常 - Unknown: 未知 示例值：Running
InstanceStatus	String	机器实例状态 示例值：Running
NodeInstanceId	String	节点实例id 示例值：ins-6a79x94v
SpecTotalCount	String	预期副本数 示例值：0

GroupPodResult

部署组实例列表

被如下接口引用：DescribePodInstances。

名称	类型	描述
TotalCount	Integer	总记录数 示例值：21
Content	Array of GroupPod	列表信息

GroupRelease

部署组配置发布相关信息

被如下接口引用：DescribeGroupRelease。

名称	类型	描述
PackageId	String	程序包ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：pkg-9198307d
PackageName	String	程序包名 注意：此字段可能返回 null，表示取不到有效值。 示例值：msgw-zuul1-1.29.20-Hoxton-Higher-RELEASE.jar
PackageVersion	String	程序包版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：20241223010307
RepoName	String	镜像名 注意：此字段可能返回 null，表示取不到有效值。 示例值：tsf_100011910000/app-provider
TagName	String	镜像版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：20241212161801
PublicConfigReleaseList	Array of ConfigRelease	已发布的全局配置列表 注意：此字段可能返回 null，表示取不到有效值。
ConfigReleaseList	Array of ConfigRelease	已发布的应用配置列表 注意：此字段可能返回 null，表示取不到有效值。
FileConfigReleaseList	Array of FileConfigRelease	已发布的文件配置列表 注意：此字段可能返回 null，表示取不到有效值。

GroupResourceConfig

部署组相关的参数配置

被如下接口引用：DescribeResourceConfig。

名称	类型	描述
Container	ContainerGroupResourceConfig	容器部署组相关的参数配置 注意：此字段可能返回 null，表示取不到有效值。

GroupUnitApiDailyUseStatistics

单元化API使用详情统计对象列表

被如下接口引用：DescribeUnitApiUseDetail。

名称	类型	描述
NamespaceId	String	命名空间ID 示例值：ns-123456
NamespaceName	String	命名空间名称 示例值：ns-test
SumReqAmount	String	该API在该命名空间下的总调用次数 示例值：8213434
AvgFailureRate	String	该API在该命名空间下的平均错误率 示例值：82.11
AvgTimeCost	String	该API在该命名空间下的平均响应时间 示例值：26.56
MetricDataPointMap	MetricDataPointMap	监控数据曲线点位图Map集合
TopStatusCode	Array of ApiUseStatisticsEntity	状态码分布详情
TopTimeCost	Array of ApiUseStatisticsEntity	耗时分布详情
Quantile	QuantileEntity	分位值对象

GroupUnitApiUseStatistics

查询网关API监控明细数据（单元化网关使用详情）

被如下接口引用：DescribeUnitApiUseDetail。

名称	类型	描述
TotalCount	Integer	总记录数 示例值：20
Content	Array of GroupUnitApiDailyUseStatistics	查询网关API监控明细对象集合

GroupUseStatisticsEntity

API分组日使用统计对象数据点

被如下接口引用：DescribeGroupUseDetail。

名称	类型	描述
ApiPath	String	API 路径 示例值：/findOne
ServiceName	String	服务名 示例值：java-demo
Value	String	统计值 示例值：20
ApiId	String	API ID 示例值：api-6a79x94v

HealthCheckConfig

健康检查配置

被如下接口引用：CreateApplication, DescribeApplication, ModifyApplication。

名称	类型	必选	描述
Path	String	否	健康检查路径 示例值：/health

HealthCheckSetting

健康检查配置信息，若不指定该参数，则默认不设置健康检查。

被如下接口引用：DeployContainerApplication, DeployContainerGroup, DeployGroup, UpdateHealthCheckSettings。

名称	类型	必选	描述
ActionType	String	是	健康检查方法。HTTP：通过 HTTP 接口检查；CMD：通过执行命令检查；TCP：通过建立 TCP 连接检查。 注意：此字段可能返回 null，表示取不到有效值。 示例值：HTTP
InitialDelaySeconds	Integer	否	容器延时启动健康检查的时间，单位秒。 注意：此字段可能返回 null，表示取不到有效值。 示例值：180
TimeoutSeconds	Integer	否	每次健康检查响应的最大超时时间，单位秒。 注意：此字段可能返回 null，表示取不到有效值。 示例值：30
PeriodSeconds	Integer	否	进行健康检查的时间间隔，单位秒。 注意：此字段可能返回 null，表示取不到有效值。 示例值：30
SuccessThreshold	Integer	否	表示后端容器从失败到成功的连续健康检查成功次数。 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
FailureThreshold	Integer	否	表示后端容器从成功到失败的连续健康检查成功次数。 注意：此字段可能返回 null，表示取不到有效值。 示例值：3
Scheme	String	否	HTTP 健康检查方法使用的检查协议。支持HTTP、HTTPS。 注意：此字段可能返回 null，表示取不到有效值。 示例值：HTTP
Port	Integer	否	健康检查端口，范围 1~65535 。 注意：此字段可能返回 null，表示取不到有效值。 示例值：8080
Path	String	否	HTTP 健康检查接口的请求路径。 注意：此字段可能返回 null，表示取不到有效值。 示例值：/health
Command	Array of String	否	执行命令检查方式，执行的命令。 注意：此字段可能返回 null，表示取不到有效值。 示例值：sh health.sh
Type	String	否	TSF_DEFAULT：tsf 默认就绪探针。K8S_NATIVE：k8s 原生探针。不填默认为 k8s 原生探针。 注意：此字段可能返回 null，表示取不到有效值。 示例值：K8S_NATIVE

HealthCheckSettings

健康检查参数

被如下接口引用：DeployContainerApplication, DeployContainerGroup, DeployGroup, DescribeContainerGroupAttribute, DescribeContainerGroupDeployInfo, DescribeContainerGroupDetail, DescribeGroup, DescribeGroupAttribute, UpdateHealthCheckSettings。

名称	类型	必选	描述
LivenessProbe	HealthCheckSetting	否	存活健康检查 注意：此字段可能返回 null，表示取不到有效值。
ReadinessProbe	HealthCheckSetting	否	就绪健康检查 注意：此字段可能返回 null，表示取不到有效值。

HttpGetOption

HttpGet 执行内容

被如下接口引用：DeployContainerApplication。

名称	类型	必选	描述
Host	String	否	主机地址 注意：此字段可能返回 null，表示取不到有效值。 示例值：tencent.com
Path	String	否	路径 注意：此字段可能返回 null，表示取不到有效值。 示例值：/tmp
Port	String	否	端口 注意：此字段可能返回 null，表示取不到有效值。 示例值：7998
Scheme	String	否	协议：HTTP｜HTTPS 注意：此字段可能返回 null，表示取不到有效值。 示例值：HTTP

ImageRepository

镜像仓库

被如下接口引用：DescribeImageRepository。

名称	类型	描述
Reponame	String	仓库名,含命名空间,如tsf/nginx 示例值：/tsf/nginx
Repotype	String	仓库类型 示例值：perosonal
TagCount	Integer	镜像版本数 示例值：12
IsPublic	Integer	是否公共,1:公有,0:私有 示例值：0
IsUserFavor	Boolean	是否被用户收藏。true：是，false：否 示例值：false
IsQcloudOfficial	Boolean	是否是腾讯云官方仓库。 是否是腾讯云官方仓库。true：是，false：否 示例值：true
FavorCount	Integer	被所有用户收藏次数 示例值：1
PullCount	Integer	拉取次数 示例值：3
Description	String	描述内容 示例值：this is a desc
CreationTime	String	创建时间 示例值：2020-12-3 09:12:16
UpdateTime	String	更新时间 示例值：158759282
TcrRepoInfo	TcrRepoInfo	TcrRepoInfo值
TcrBindingId	Integer	TcrBindingId值 示例值：tbind-6a79x94v
ApplicationId	String	applicationid值 示例值：application-6a79x94v
ApplicationNameReal	String	ApplicationName值 示例值：nginx
Public	Integer	是否公共,1:公有,0:私有 示例值：0
CreateMode	String	创建方式：manual | automatic 示例值：auto
RepoName	String	仓库名，等同reponame字段 示例值：/tsf/nginx
RepoType	String	仓库类型 示例值：perosonal

ImageRepositoryResult

镜像仓库列表

被如下接口引用：DescribeImageRepository。

名称	类型	描述
TotalCount	Integer	总记录数 示例值：20
Server	String	镜像服务器地址 示例值：ccr.tencent.com
Content	Array of ImageRepository	列表信息

ImageTag

列表信息

被如下接口引用：DescribeImageTags。

名称	类型	描述
RepoName	String	仓库名 示例值：/tsf/nginx
TagName	String	版本名称 示例值：latest
TagId	String	版本ID 示例值：tag-6a79x94v
ImageId	String	镜像ID 示例值：img-6a79x94v
Size	String	大小 示例值：64m
CreationTime	String	创建时间 示例值：2020-12-11 09:33:13
UpdateTime	String	更新时间 示例值：1527349021
Author	String	镜像制作者 示例值：username
Architecture	String	CPU架构 示例值：x86
DockerVersion	String	Docker客户端版本 示例值：1.19
Os	String	操作系统 示例值：centos
PushTime	String	push时间 示例值：156283099
SizeByte	Integer	单位为字节 示例值：64000
TcrRepoInfo	TcrRepoInfo	TcrRepoInfo值

ImageTagsResult

镜像版本列表

被如下接口引用：DescribeImageTags。

名称	类型	描述
TotalCount	Integer	总记录数 示例值：20
RepoName	String	仓库名,含命名空间,如tsf/ngin 示例值：/tsf/nginx
Server	String	镜像服务器地址 示例值：ccr.tencent.com
Content	Array of ImageTag	列表信息

IndicatorCoord

监控指标坐标

被如下接口引用：DescribeInovcationIndicators。

名称	类型	描述
CoordX	String	指标横坐标值 示例值：12
CoordY	String	指标纵坐标值 示例值：12
CoordTag	String	指标标签，用于标识附加信息 示例值：time

Instance

机器实例

被如下接口引用：DescribeClusterInstances, DescribeGroupInstances。

名称	类型	必选	描述
InstanceId	String	否	机器实例ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：ins-0xdahvt2
InstanceName	String	否	机器名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：cvm_app
LanIp	String	否	机器内网地址IP 注意：此字段可能返回 null，表示取不到有效值。 示例值：10.0.0.12
WanIp	String	否	机器外网地址IP 注意：此字段可能返回 null，表示取不到有效值。 示例值：10.0.0.1
InstanceDesc	String	否	机器描述信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：This is desc
ClusterId	String	否	集群ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：cls-i3v5y09e
ClusterName	String	否	集群名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：cls_app
InstanceStatus	String	否	VM的状态 虚机：虚机的状态 容器：Pod所在虚机的状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：Running
InstanceAvailableStatus	String	否	VM的可使用状态 虚机：虚机是否能够作为资源使用 容器：虚机是否能够作为资源部署POD 注意：此字段可能返回 null，表示取不到有效值。 示例值：Running
ServiceInstanceStatus	String	否	服务下的服务实例的状态 虚机：应用是否可用 + Agent状态 容器：Pod状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：Running
CountInTsf	Integer	否	标识此instance是否已添加在tsf中 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
GroupId	String	否	机器所属部署组ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：group-xoydmy26
ApplicationId	String	否	机器所属应用ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：application-l6ymbvgd
ApplicationName	String	否	机器所属应用名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：app_provider
InstanceCreatedTime	String	否	机器实例在CVM的创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-12-16 11:28:01
InstanceExpiredTime	String	否	机器实例在CVM的过期时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-12-16 11:28:01
InstanceChargeType	String	否	机器实例在CVM的计费模式 注意：此字段可能返回 null，表示取不到有效值。 示例值：PREPAID
InstanceTotalCpu	Float	否	机器实例总CPU信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：1.9
InstanceTotalMem	Float	否	机器实例总内存信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：2.4473
InstanceUsedCpu	Float	否	机器实例使用的CPU信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：1.16
InstanceUsedMem	Float	否	机器实例使用的内存信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：1.45
InstanceLimitCpu	Float	否	机器实例Limit CPU信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：1.5
InstanceLimitMem	Float	否	机器实例Limit 内存信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：2.5
InstancePkgVersion	String	否	包版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：v1
ClusterType	String	否	集群类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：C
RestrictState	String	否	机器实例业务状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：NORMAL
UpdateTime	String	否	更新时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-12-16 11:28:01
OperationState	Integer	否	实例执行状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
NamespaceId	String	否	NamespaceId Ns ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：namespace-96a79v5b
InstanceZoneId	String	否	InstanceZoneId 可用区ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：zone-57at58po
InstanceImportMode	String	否	InstanceImportMode 导入模式 注意：此字段可能返回 null，表示取不到有效值。 示例值：M
ApplicationType	String	否	ApplicationType应用类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：C
ApplicationResourceType	String	否	ApplicationResourceType 资源类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：DEF
ServiceSidecarStatus	String	否	sidecar状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：up
GroupName	String	否	部署组名 注意：此字段可能返回 null，表示取不到有效值。 示例值：group_app
NamespaceName	String	否	NS名 注意：此字段可能返回 null，表示取不到有效值。 示例值：ns_app
Reason	String	否	健康检查原因 注意：此字段可能返回 null，表示取不到有效值。 示例值：This is desc
AgentVersion	String	否	agent版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：v1
NodeInstanceId	String	否	容器母机实例ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：ins-fl5gwz2e

InstanceAdvancedSettings

容器导入实例高级设置

被如下接口引用：AddClusterInstances。

名称	类型	必选	描述
MountTarget	String	是	数据盘挂载点, 默认不挂载数据盘. 已格式化的 ext3，ext4，xfs 文件系统的数据盘将直接挂载，其他文件系统或未格式化的数据盘将自动格式化为ext4 并挂载，请注意备份数据! 无数据盘或有多块数据盘的云主机此设置不生效。 注意，注意，多盘场景请使用下方的DataDisks数据结构，设置对应的云盘类型、云盘大小、挂载路径、是否格式化等信息。 注意：此字段可能返回 null，表示取不到有效值。 示例值：ext4
DockerGraphPath	String	是	dockerd --graph 指定值, 默认为 /var/lib/docker 注意：此字段可能返回 null，表示取不到有效值。 示例值：/var/lib/docker

InstanceEnrichedInfo

包含虚拟机所在TSF中的位置信息

被如下接口引用：DescribeInstances。

名称	类型	描述
InstanceId	String	机器ID 示例值：ins-6a79x94v
InstanceName	String	机器名称 示例值：cvm-1
LanIp	String	机器内网IP 示例值：10.20.34.1
WanIp	String	机器外网IP 示例值：10.12.32.3
VpcId	String	机器所在VPC 示例值：vpc-6a79x94v
InstanceStatus	String	机器运行状态，枚举值为： - Pending: 准备中 - Running: 运行中 - Stopped: 已停止 - Rebooting: 重启中 - Starting: 启动中 - Stopping: 停止中 - Abnormal: 异常 - Unknown: 未知 - Offline: 离线 示例值：running
InstanceAvailableStatus	String	机器可用状态（表示机器上的Agent在线） 示例值：running
ApplicationId	String	应用ID 示例值：application-6a79x94v
ApplicationName	String	应用名称 示例值：java-demo
ApplicationType	String	应用类型，C表示容器应用，V表示虚拟机应用 示例值：C
ClusterId	String	集群ID 示例值：cls-6a79x94v
ClusterName	String	集群名称 示例值：k8s-cls
ClusterType	String	集群类型，C表示容器集群，V表示虚拟机集群 示例值：C
NamespaceId	String	命名空间ID 示例值：namespace-6a79x94v
NamespaceName	String	命名空间名称 示例值：default
GroupId	String	机器所在部署组ID 示例值：group-6a79x94v
GroupName	String	部署组名称 示例值：group-mock

InstanceEnrichedInfoPage

InstanceEnrichedInfo列表结构

被如下接口引用：DescribeInstances。

名称	类型	描述
TotalCount	Integer	总数量 示例值：20
Content	Array of InstanceEnrichedInfo	列表

InstanceResourceConfig

实例相关的参数配置

被如下接口引用：DescribeResourceConfig。

名称	类型	描述
Container	ContainerInstanceResourceConfig	容器实例相关的参数配置 注意：此字段可能返回 null，表示取不到有效值。
Vm	VmInstanceResourceConfig	虚拟机实例相关的参数配置 注意：此字段可能返回 null，表示取不到有效值。

InvocationIndicator

服务调用监控指标

被如下接口引用：DescribeInovcationIndicators。

名称	类型	描述
InvocationQuantity	Integer	总请求数 注意：此字段可能返回 null，表示取不到有效值。 示例值：190
InvocationSuccessRate	Float	请求成功率，百分比 注意：此字段可能返回 null，表示取不到有效值。 示例值：0.25
InvocationAvgDuration	Float	请求平均耗时，单位毫秒 注意：此字段可能返回 null，表示取不到有效值。 示例值：38
InvocationSuccessDistribution	Array of IndicatorCoord	成功请求数时间分布
InvocationFailedDistribution	Array of IndicatorCoord	失败请求数时间分布
InvocationStatusDistribution	Array of IndicatorCoord	状态码分布
InvocationDurationDistribution	Array of IndicatorCoord	时延分布
InvocationQuantityDistribution	Array of IndicatorCoord	并发请求次数时间分布

InvocationMetricScatterPlot

监控数据散点图

被如下接口引用：DescribeInvocationMetricScatterPlot。

名称	类型	描述
EndTime	Integer	时间轴截止时间，GMT，精确到毫秒 示例值：1616656231170
StartTime	Integer	时间粒度 示例值：60
Period	Integer	时间轴开始时间，GMT，精确到毫秒 示例值：1616656231170
DataPoints	Array of MultiValueDataPoints	多值数据点集合

JvmMonitorData

DescribeJvmMonitor查询jvm监控数据接口返回数据封装

被如下接口引用：DescribeJvmMonitor。

名称	类型	描述
HeapMemory	MemoryPicture	堆内存监控图,三条线 注意：此字段可能返回 null，表示取不到有效值。
NonHeapMemory	MemoryPicture	非堆内存监控图,三条线 注意：此字段可能返回 null，表示取不到有效值。
EdenSpace	MemoryPicture	伊甸园区监控图,三条线 注意：此字段可能返回 null，表示取不到有效值。
SurvivorSpace	MemoryPicture	幸存者区监控图,三条线 注意：此字段可能返回 null，表示取不到有效值。
OldSpace	MemoryPicture	老年代监控图,三条线 注意：此字段可能返回 null，表示取不到有效值。
MetaSpace	MemoryPicture	元空间监控图,三条线 注意：此字段可能返回 null，表示取不到有效值。
ThreadPicture	ThreadPicture	线程监控图,三条线 注意：此字段可能返回 null，表示取不到有效值。
YoungGC	Array of CurvePoint	youngGC增量监控图,一条线 注意：此字段可能返回 null，表示取不到有效值。
FullGC	Array of CurvePoint	fullGC增量监控图,一条线 注意：此字段可能返回 null，表示取不到有效值。
CpuUsage	Array of CurvePoint	cpu使用率,一条线 注意：此字段可能返回 null，表示取不到有效值。
ClassCount	Array of CurvePoint	加载类数,一条线 注意：此字段可能返回 null，表示取不到有效值。

KafkaDeliveryConfig

投递kafka配置项

被如下接口引用：DescribeDeliveryConfig。

名称	类型	描述
ConfigId	String	配置项id 示例值：config-6a79x94v
ConfigName	String	配置名称 示例值：send_kafka_config
CollectPath	Array of String	采集路径 示例值：/var/log
KafkaVIp	String	kafka vip 示例值：10.23.0.1
KafkaVPort	String	kafka vport 注意：此字段可能返回 null，表示取不到有效值。 示例值：9090
Topic	String	kafka topic 示例值：SEND_KAFKA_TOPIC
LineRule	String	换行规则 示例值：.*
EnableAuth	Boolean	是否需要认证 示例值：false
Username	String	用户名 注意：此字段可能返回 null，表示取不到有效值。 示例值：root
Password	String	密码 注意：此字段可能返回 null，表示取不到有效值。 示例值：pwd-xxxxx
KafkaInfos	Array of DeliveryKafkaInfo	投递的topic和path
EnableGlobalLineRule	Boolean	是否应用单行规则 示例值：false
CustomRule	String	自定义分行规则 注意：此字段可能返回 null，表示取不到有效值。 示例值：.*
KafkaAddress	String	KafkaAddress 注意：此字段可能返回 null，表示取不到有效值。 示例值：kafka.tencent.com

LaneGroup

泳道部署组

被如下接口引用：CreateLane, DescribeLanes。

名称	类型	必选	描述
GroupId	String	是	部署组ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：group-py5436a4
Entrance	Boolean	是	是否入口应用 注意：此字段可能返回 null，表示取不到有效值。 示例值：true
LaneGroupId	String	否	泳道部署组ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：lane-g-a7or5ebv
LaneId	String	否	泳道ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：lane-y9647wgy
GroupName	String	否	部署组名 注意：此字段可能返回 null，表示取不到有效值。 示例值：group_app
ApplicationId	String	否	应用ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：application-byxz6gal
ApplicationName	String	否	应用名 注意：此字段可能返回 null，表示取不到有效值。 示例值：app_provider
NamespaceId	String	否	命名空间ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：namespace-6ymbn3vg
NamespaceName	String	否	命名空间名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：ns_app
CreateTime	Integer	否	创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1732784732000
UpdateTime	Integer	否	更新时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1732784732000
ClusterType	String	否	集群类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：V

LaneInfo

泳道

被如下接口引用：DescribeLanes。

名称	类型	必选	描述
LaneId	String	否	泳道ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：lane-y9647wgy
LaneName	String	否	泳道名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：lane_app
Remark	String	否	泳道备注 注意：此字段可能返回 null，表示取不到有效值。 示例值：This is desc
CreateTime	Integer	否	创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1732784732000
UpdateTime	Integer	否	更新时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1732784732000
LaneGroupList	Array of LaneGroup	否	泳道部署组 注意：此字段可能返回 null，表示取不到有效值。
Entrance	Boolean	否	是否入口应用 注意：此字段可能返回 null，表示取不到有效值。 示例值：true
NamespaceIdList	Array of String	否	泳道已经关联部署组的命名空间列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：["namespace-96a79v5b"]
LaneGroupId	String	否	泳道部署组ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：lane-g-a7or5ebv
DeleteDisabled	Boolean	否	是否禁用删除。 true：禁用 false：取消禁用 示例值：true
DeleteDisabledReason	String	否	禁用原因 示例值：该泳道已关联全链路灰度发布规则,请先从规则中移除后删除

LaneInfos

泳道分页查询

被如下接口引用：DescribeLanes。

名称	类型	描述
TotalCount	Integer	总数 示例值：100
Content	Array of LaneInfo	泳道信息列表 示例值：[{"LaneId":"lane-v3jmz43n","LaneName":"lane-1120-edc-sams-qa","Remark":"lane-1120-edc-sams-qa","CreateTime":1731419303000,"UpdateTime":1734681365000,"LaneGroupList":null,"Entrance":null,"NamespaceIdList":null}]

LaneRule

泳道规则

被如下接口引用：DescribeLaneRules。

名称	类型	描述
RuleId	String	泳道规则ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：lane-r-by8n9xyk
RuleName	String	泳道规则名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：rule_app
Priority	Integer	优先级 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
Remark	String	备注 注意：此字段可能返回 null，表示取不到有效值。 示例值：This is desc
RuleTagList	Array of LaneRuleTag	泳道规则标签列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：[{"Id":"unit-tag-vmhijoic","UnitRuleItemId":"unit-item-ghpuh9rn","TagType":"U","TagField":"user","TagOperator":"IN","TagValue":"1","ItemIndex":1,"CreatedTime":"2024-12-23 11:14:17","UpdatedTime":"2024-12-23 11:14:17"}]
RuleTagRelationship	String	泳道规则标签关系 注意：此字段可能返回 null，表示取不到有效值。 示例值：RELEATION_AND
LaneId	String	泳道ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：lane-zvw7xxy8
Enable	Boolean	开启状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：0
CreateTime	Integer	创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1732784732000
UpdateTime	Integer	更新时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1732784732000

LaneRuleTag

泳道规则标签

被如下接口引用：CreateLaneRule, DescribeLaneRules, ModifyLaneRule。

名称	类型	必选	描述
TagId	String	否	标签ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：lane-t-nalb72vq
TagName	String	否	标签名 注意：此字段可能返回 null，表示取不到有效值。 示例值：user
TagOperator	String	否	标签操作符 注意：此字段可能返回 null，表示取不到有效值。 示例值：EQUAL
TagValue	String	否	标签值 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
LaneRuleId	String	否	泳道规则ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：lane-r-by8n9xyk
CreateTime	Integer	否	创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1732784732000
UpdateTime	Integer	否	更新时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1732784732000

LaneRules

泳道规则分页查询

被如下接口引用：DescribeLaneRules。

名称	类型	描述
TotalCount	Integer	总数 示例值：100
Content	Array of LaneRule	泳道规则列表 示例值：[{"RuleId":"lane-r-v6ewp385","RuleName":"rule_app","Priority":1,"Remark":"This is desc","RuleTagList":null,"RuleTagRelationship":"RELEATION_AND","LaneId":"lane-ynmlnwm4","Enable":true,"CreateTime":1725509095000,"UpdateTime":1727167548000}]

LicenseTag

许可标签

被如下接口引用：DescribeLicenses。

名称	类型	描述
LicenseId	String	许可ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：tsf-jhdas5d3
Tags	Array of Tag	标签列表 注意：此字段可能返回 null，表示取不到有效值。

LifeCycleHook

LifeCycleHook

被如下接口引用：DeployContainerApplication。

名称	类型	必选	描述
HookType	String	否	生命周期函数类型：PostStart|PreStop 注意：此字段可能返回 null，表示取不到有效值。 示例值：postStart
ExecMode	String	否	函数执行方式：execCommand|httpGet|none 注意：此字段可能返回 null，表示取不到有效值。 示例值：httpGet
ExecCommandContent	String	否	execCommand函数执行内容 注意：此字段可能返回 null，表示取不到有效值。 示例值：/bin/sh\n-c\nsleep 35
HttpGetOption	HttpGetOption	否	HttpGet执行内容 注意：此字段可能返回 null，表示取不到有效值。

MemoryPicture

Jvm监控内存数据封装

被如下接口引用：DescribeJvmMonitor。

名称	类型	描述
Max	Array of CurvePoint	内存最大值
Used	Array of CurvePoint	已用内存大小
Committed	Array of CurvePoint	系统分配内存大小

Metric

指标

被如下接口引用：DescribeInvocationMetricDataCurve, DescribeInvocationMetricDataPoint, DescribeInvocationMetricScatterPlot。

名称	类型	必选	描述
Name	String	否	指标名称 示例值：time
Function	String	否	指标计算方式，可选值： none：无，sum：求和，exclusive：独占值，avg：平均值，max：最大值，min：最小值，percentage_50：50分位数，percentage_75：75分位数，percentage_95：95分位数，percentage_99：99分位数，bucket_5：分桶统计。 示例值：count

MetricDataCurve

指标监控数据曲线

被如下接口引用：DescribeInvocationMetricDataCurve, DescribeStatistics。

名称	类型	描述
MetricName	String	指标名称 示例值：host
MetricFunction	String	指标计算方式 示例值：count
MetricDataPoints	Array of MetricDataPoint	指标数据点集合

MetricDataPoint

监控统计数据点

被如下接口引用：DescribeInvocationMetricDataCurve, DescribeOverviewInvocation, DescribeUnitApiUseDetail。

名称	类型	描述
Key	String	数据点键 示例值：host
Value	String	数据点值 示例值：cvm-1
Tag	String	数据点标签 示例值：host

MetricDataPointMap

监控统计数据点Map集合（单元化网关使用）

被如下接口引用：DescribeUnitApiUseDetail。

名称	类型	描述
SumReqAmount	Array of MetricDataPoint	总调用次数监控数据点集合
AvgFailureRate	Array of MetricDataPoint	平均错误率监控数据点集合
AvgTimeCost	Array of MetricDataPoint	平均响应时间监控数据点集合

MetricDataSingleValue

单值指标

被如下接口引用：DescribeInvocationMetricDataPoint。

名称	类型	描述
MetricName	String	指标 示例值：reqCount
MetricFunction	String	统计方式 示例值：sum
MetricDataValue	String	指标值 示例值：1
DailyPercent	Float	日环比 示例值：1

MetricDimension

指标维度

被如下接口引用：DescribeInvocationMetricDataCurve, DescribeInvocationMetricScatterPlot。

名称	类型	必选	描述
Name	String	否	指标维度名称 示例值：host
Value	String	否	指标维度取值 示例值：cvm-1

MetricDimensionValue

指标维度多值匹配。可选值 NamespaceId：命名空间ID，GroupId：部署组ID，InstanceId：实例ID，ApplicationId：应用ID，OperationMethod：执行方法，OperationName：执行名称，ServiceName：服务名，UpstreamNamespaceId：上游命名空间ID

被如下接口引用：DescribeInvocationMetricDataDimension, DescribeInvocationMetricDataPoint, DescribeStatistics。

名称	类型	必选	描述
Name	String	是	维度名 示例值：NamespaceId
Value	Array of String	是	维度值 示例值：["namespace-xxxxxxxx"]

Microservice

微服务

被如下接口引用：DescribeMicroservices, DescribeMicroservicesByGroupIds。

名称	类型	必选	描述
MicroserviceId	String	否	微服务ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：ms-vzge6mz8
MicroserviceName	String	否	微服务名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：consumer-demo
MicroserviceDesc	String	否	微服务描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：This is desc
CreateTime	Integer	否	创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1732784732000
UpdateTime	Integer	否	更新时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1732784732000
NamespaceId	String	否	命名空间ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：namespace-96a79v5b
RunInstanceCount	Integer	否	微服务的运行实例数目 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
CriticalInstanceCount	Integer	否	微服务的离线实例数目 注意：此字段可能返回 null，表示取不到有效值。 示例值：1

MonitorOverview

监控概览对象

被如下接口引用：DescribeGatewayMonitorOverview。

名称	类型	描述
InvocationCountOfDay	String	近24小时调用数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：13412691
InvocationCount	String	总调用数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：13412691
ErrorCountOfDay	String	近24小时调用错误数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：292635
ErrorCount	String	总调用错误数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：292635
SuccessRatioOfDay	String	近24小时调用成功率 注意：此字段可能返回 null，表示取不到有效值。 示例值：0.97
SuccessRatio	String	总调用成功率 注意：此字段可能返回 null，表示取不到有效值。 示例值：0.97

MsApiArray

微服务API数组

被如下接口引用：DescribeMsApiList。

名称	类型	描述
Path	String	API 请求路径 示例值：/echo
Method	String	请求方法 示例值：GET
Description	String	方法描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：This is desc
Status	Integer	API状态 0:离线 1:在线 注意：此字段可能返回 null，表示取不到有效值。 示例值：1

MsInstance

微服务实例信息

被如下接口引用：DescribeMicroservice。

名称	类型	描述
InstanceId	String	机器实例ID信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：ins-anrptnkf
InstanceName	String	机器实例名称信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：ins_cvm
Port	String	服务运行的端口号 注意：此字段可能返回 null，表示取不到有效值。 示例值：8080
LanIp	String	机器实例内网IP 注意：此字段可能返回 null，表示取不到有效值。 示例值：192.168.0.1
WanIp	String	机器实例外网IP 注意：此字段可能返回 null，表示取不到有效值。 示例值：192.168.0.1
InstanceAvailableStatus	String	机器可用状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：Running
ServiceInstanceStatus	String	服务运行状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：Running
ApplicationId	String	应用ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：application-l6ymbvgd
ApplicationName	String	应用名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：provider_app
ClusterId	String	集群ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：cluster-mjy9mvgz
ClusterName	String	集群名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：cls_app
NamespaceId	String	命名空间ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：namespace-96a79v5b
NamespaceName	String	命名空间名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：ns_app
GroupId	String	部署组ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：group-xoydmy26
GroupName	String	部署组名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：group_app
InstanceStatus	String	机器TSF可用状态 注意：此字段可能返回 null，表示取不到有效值。 示例值：ready
HealthCheckUrl	String	健康检查URL 注意：此字段可能返回 null，表示取不到有效值。 示例值：/heath
ClusterType	String	集群类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：C
ApplicationPackageVersion	String	应用程序包版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：v1
ApplicationType	String	应用类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：C
ServiceStatus	String	服务状态，passing 在线，critical 离线 注意：此字段可能返回 null，表示取不到有效值。 示例值：passing
RegistrationTime	Integer	注册时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1732784732000
LastHeartbeatTime	Integer	上次心跳时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：1732784732000
RegistrationId	String	实例注册id 注意：此字段可能返回 null，表示取不到有效值。 示例值：ins-apigateway-service-online-845f765877-2gz57
HiddenStatus	String	屏蔽状态，hidden 为屏蔽，unhidden 为未屏蔽 注意：此字段可能返回 null，表示取不到有效值。 示例值：unhidden
MetaJson	String	json格式的 meta 信息 注意：此字段可能返回 null，表示取不到有效值。

MultiValue

多值数据

被如下接口引用：DescribeInvocationMetricScatterPlot。

名称	类型	描述
Values	Array of Float	数据点 示例值：[1,2,3]

MultiValueDataPoints

多值数据点集合

被如下接口引用：DescribeInvocationMetricScatterPlot。

名称	类型	描述
Points	Array of MultiValue	多值数据点 示例值：[[1,2]]
MetricName	String	指标名称 示例值：count_req
PointKeys	Array of String	多值数据点key列表，每个值表示当前数据点所在区域的下限 示例值：["a","b"]

Namespace

命名空间

被如下接口引用：DescribeSimpleNamespaces。

名称	类型	描述
NamespaceId	String	命名空间ID 示例值：namespace-6a79x94v
NamespaceCode	String	命名空间编码 示例值：code1
NamespaceName	String	命名空间名称 示例值：default
NamespaceDesc	String	命名空间描述 示例值：k8s default
IsDefault	String	默认命名空间 示例值：true
NamespaceStatus	String	命名空间状态 示例值：running
DeleteFlag	Boolean	删除标识 示例值：false
CreateTime	String	创建时间 示例值：2020-11-21 11:31:22
UpdateTime	String	更新时间 示例值：152739037
ClusterList	Array of Cluster	集群数组，仅携带集群ID，集群名称，集群类型等基础信息。
ClusterId	String	集群ID 示例值：cls-6a79x94v
NamespaceResourceType	String	集群资源类型 示例值：C
NamespaceType	String	命名空间类型 示例值：default
IsHaEnable	String	是否开启高可用 示例值：false
KubeInjectEnable	Boolean	KubeInjectEnable值 示例值：false

OperationInfo

提供给前端，控制按钮是否显示

被如下接口引用：DescribeClusters, DescribeSimpleClusters。

名称	类型	描述
Init	OperationInfoDetail	初始化按钮的控制信息
AddInstance	OperationInfoDetail	添加实例按钮的控制信息
Destroy	OperationInfoDetail	销毁机器的控制信息

OperationInfoDetail

提供给前端控制按钮显示逻辑的字段

被如下接口引用：DescribeClusters, DescribeSimpleClusters。

名称	类型	描述
DisabledReason	String	不显示的原因 示例值：this is a reason
Enabled	Boolean	该按钮是否可点击 示例值：false
Supported	Boolean	是否显示该按钮 示例值：true

OverviewBasicResourceUsage

TSF基本资源信息概览

被如下接口引用：DescribeBasicResourceUsage。

名称	类型	描述
ApplicationCount	Integer	应用总数 示例值：3
NamespaceCount	Integer	命名空间总数 示例值：3
GroupCount	Integer	部署组个数 示例值：4
PackageSpaceUsed	Integer	程序包存储空间用量，单位字节 示例值：122345
ConsulInstanceCount	Integer	已注册实例数 示例值：12

PackageConfig

程序包相关配置信息

被如下接口引用：DescribeResourceConfig。

名称	类型	描述
SpaceSize	Integer	程序包存储空间大小，单位字节 注意：此字段可能返回 null，表示取不到有效值。 示例值：10737418

PagedProgram

tsf-privilege模块，分页数据集列表

被如下接口引用：DescribePrograms。

名称	类型	描述
TotalCount	Integer	总条数 示例值：27
Content	Array of Program	数据集列表

PathRewrite

路径重写

被如下接口引用：DescribePathRewrite, DescribePathRewrites。

名称	类型	描述
PathRewriteId	String	路径重写规则ID 示例值：rewrite-96a79v5b
GatewayGroupId	String	网关部署组ID 示例值：group-nalbg4vq
Regex	String	正则表达式 示例值：/echo/(.*)
Replacement	String	替换的内容 示例值：/gw/provider-demo/echo/$1
Blocked	String	是否屏蔽映射后路径，Y: 是 N: 否 示例值：N
Order	Integer	规则顺序，越小优先级越高 示例值：1

PathRewriteCreateObject

路径重写创建对象

被如下接口引用：CreatePathRewrites, CreatePathRewritesWithDetailResp。

名称	类型	必选	描述
GatewayGroupId	String	是	网关部署组ID 示例值：group-ldap5yok
Regex	String	是	正则表达式 示例值：/consumer
Replacement	String	是	替换的内容 示例值：/provider
Blocked	String	是	是否屏蔽映射后路径，Y: 是 N: 否 示例值：N
Order	Integer	是	规则顺序，越小优先级越高 示例值：1

PathRewritePage

路径重写翻页对象

被如下接口引用：DescribePathRewrites。

名称	类型	描述
TotalCount	Integer	总记录数 示例值：100
Content	Array of PathRewrite	路径重写规则列表 示例值：[{"PathRewriteId":"rewrite-qab42qxv","GatewayGroupId":"group-yd3b588a","Regex":"/provider_user","Replacement":"/consumer_user","Blocked":"N","Order":1}]

PkgBind

描述程序包关联信息

被如下接口引用：DescribePkgs。

名称	类型	描述
ApplicationId	String	应用id 示例值：application-6a79x94v
GroupId	String	部署组id 示例值：group-6a79x94v

PkgInfo

包信息

被如下接口引用：DescribePkgs。

名称	类型	描述
PkgId	String	程序包ID 示例值：pkg-6a79x94v
PkgName	String	程序包名 示例值：java-demo.jar
PkgType	String	程序包类型 示例值：fatjar
PkgVersion	String	程序包版本 示例值：latest
PkgDesc	String	程序包描述 示例值：this is a desc
UploadTime	String	上传时间 示例值：2020-12-30 11:23:31
Md5	String	程序包MD5 示例值：md50xxxxxxxx
PkgPubStatus	Integer	程序包状态 示例值：1
PkgBindInfo	Array of PkgBind	程序包关联关系

PkgList

包列表

被如下接口引用：DescribePkgs。

名称	类型	描述
TotalCount	Integer	程序包总量 示例值：20
Content	Array of PkgInfo	程序包信息列表
RepositoryId	String	程序包仓库id 示例值：repo-6a79x94v
RepositoryType	String	程序包仓库类型 示例值：tcr
RepositoryName	String	程序包仓库名称 示例值：tsf-demo

Ports

服务端口

被如下接口引用：CreateApplication, DescribeApplication, ModifyApplication。

名称	类型	必选	描述
TargetPort	Integer	是	服务端口 示例值：8080
Protocol	String	是	端口协议，TCP或者UDP 示例值：TCP

Program

tsf-privilege模块 Program数据集

被如下接口引用：DescribePrograms。

名称	类型	必选	描述
ProgramId	String	否	数据集ID 示例值：program-6a79x94v
ProgramName	String	否	数据集名称 示例值：program-test
ProgramDesc	String	否	数据集描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：this is a desc
DeleteFlag	Boolean	否	删除标识，true: 可以删除; false: 不可删除 注意：此字段可能返回 null，表示取不到有效值。 示例值：false
CreationTime	Integer	否	创建时间 示例值：15629342739
LastUpdateTime	Integer	否	最后更新时间 示例值：15629342739
ProgramItemList	Array of ProgramItem	否	数据项列表，无值时返回空数组

ProgramItem

tsf-privilege模块，数据项

被如下接口引用：CreateProgram, DescribePrograms, ModifyProgram。

名称	类型	必选	描述
ProgramItemId	String	否	数据项ID，调用DescribePrograms接口查询已创建的数据集或登陆控制台进行查看；也可以通过调用CreateProgram创建新的数据集。 示例值：prog-item-6a79x94v
Resource	Resource	否	资源
ValueList	Array of String	否	数据值列表 示例值：["1"]
IsAll	Boolean	否	全选标识，true: 全选；false: 非全选 示例值：true
CreationTime	Integer	否	创建时间，时间戳格式【Long】 示例值：174594239000
LastUpdateTime	Integer	否	最后更新时间，时间戳格式【Long】，单位毫秒 示例值：174594239000
DeleteFlag	Boolean	否	删除标识，true: 可删除；false: 不可删除 示例值：false
ProgramId	String	否	数据集ID，调用DescribePrograms查询接口获取 示例值：["program-6a79x94v"]

PropertyField

属性字段

被如下接口引用：DescribeApiDetail。

名称	类型	描述
Name	String	属性名称 示例值：tagName
Type	String	属性类型 示例值：string
Description	String	属性描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：tagName

ProtocolPort

端口对象

被如下接口引用：CreateContainGroup, DeployContainerApplication, DeployContainerGroup, DescribeContainerGroupDeployInfo, DescribeContainerGroupDetail, ModifyContainerGroup。

名称	类型	必选	描述
Protocol	String	是	TCP UDP 示例值：TCP
Port	Integer	是	服务端口 示例值：8080
TargetPort	Integer	是	容器端口 示例值：8080
NodePort	Integer	否	主机端口 示例值：30090
Name	String	否	端口名称 示例值：port-0

QuantileEntity

分位数据模型

被如下接口引用：DescribeApiUseDetail, DescribeUnitApiUseDetail。

名称	类型	描述
MaxValue	String	最大值 注意：此字段可能返回 null，表示取不到有效值。 示例值：295.6
MinValue	String	最小值 注意：此字段可能返回 null，表示取不到有效值。 示例值：9.77
FifthPositionValue	String	五分位值 注意：此字段可能返回 null，表示取不到有效值。 示例值：12.51
NinthPositionValue	String	九分位值 注意：此字段可能返回 null，表示取不到有效值。 示例值：15.18

RepositoryInfo

仓库信息

被如下接口引用：DescribeRepositories, DescribeRepository。

名称	类型	描述
RepositoryId	String	仓库ID 示例值：application-6a79x94v
RepositoryName	String	仓库名称 示例值：java-demo
RepositoryType	String	仓库类型（默认仓库：default，私有仓库：private） 示例值：default
RepositoryDesc	String	仓库描述 示例值：this is a desc
IsUsed	Boolean	仓库是否正在被使用 示例值：1
CreateTime	String	仓库创建时间 示例值：2020-12-16 12:34:51
BucketName	String	仓库桶名称 示例值：demo-bucket
BucketRegion	String	仓库桶所在地域 示例值：ap-guangzhou
Directory	String	仓库目录 示例值：/tsf

RepositoryList

仓库列表

被如下接口引用：DescribeRepositories。

名称	类型	描述
TotalCount	Integer	仓库总量 示例值：20
Content	Array of RepositoryInfo	仓库信息列表

Resource

tsf-privilege 模块，资源

被如下接口引用：CreateProgram, ModifyProgram。

名称	类型	必选	描述
ResourceId	String	否	资源ID，调用DescribeResources接口，查看接口返回的ResourceId 示例值：resource-6a79x94v
ResourceCode	String	否	资源编码，枚举值描述【cluster（集群）、namespace（命名空间）、config（应用配置）】 示例值：FindOne
ResourceName	String	否	资源名称 示例值：FindOne
ServiceCode	String	否	资源所属产品编码，枚举值描述【tsf】 示例值：tsf
ResourceAction	String	否	选取资源使用的Action，枚举值描述【DescribeSimpleCluster（查询简单集群列表）、DescribeTaskRecords（查询任务列表）】 示例值：FindOne
IdField	String	否	资源数据查询的ID字段名，调用DescribeResources接口，查看接口返回的IdField 示例值：ResourceId
NameField	String	否	资源数据查询的名称字段名 示例值：ResourceName
SelectIdsField	String	否	资源数据查询的ID过滤字段名 示例值：Ids
CreationTime	Integer	否	创建时间，时间戳格式【Long】 示例值：1279033108
LastUpdateTime	Integer	否	最后更新时间，时间戳格式【Long】 示例值：1803792739
DeleteFlag	Boolean	否	删除标识 示例值：false
ResourceDesc	String	否	资源描述 示例值：this is a desc
CanSelectAll	Boolean	否	是否可以选择全部 示例值：false
SearchWordField	String	否	资源数据查询的模糊查询字段名 示例值：ResourceCode
Index	Integer	否	排序，枚举值描述【10、20、77】 示例值：1

ResourceFieldRef

k8s env 的 ResourceFieldRef

被如下接口引用：DeployContainerApplication, DeployContainerGroup, DescribeContainerGroupDeployInfo。

名称	类型	必选	描述
Resource	String	否	k8s 的 Resource 示例值：limits.cpu

ResourceTaskStatusResult

资源任务转态结果

被如下接口引用：DescribeResourceTaskStatus。

名称	类型	描述
TaskStatus	Integer	变更状态： - 0：成功 - 1：失败 - 2：执行中 示例值：0

SchedulingStrategy

tsf 容器集群节点调度策略

被如下接口引用：DeployContainerApplication, DeployContainerGroup。

名称	类型	必选	描述
Type	String	是	NONE：不使用调度策略；CROSS_AZ：跨可用区部署 示例值：NONE
NodeScheduleStrategyType	String	否	- 示例值：NoSchedule
NodeScheduleOptions	Array of CommonOption	否	-
StrongAffinityList	Array of CommonOption	否	-
WeakAffinityList	Array of CommonOption	否	-
WeakAffinityWeight	Integer	否	- 示例值：50
AvailableZoneScatterScheduleType	String	否	- 示例值：podAntiAffinity
AvailableZoneScatterScheduleRules	Array of AvailableZoneScatterScheduleRule	否	-
PodScheduleStrategyType	String	否	- 示例值：podAntiAffinity
CustomPodSchedule	CustomPodSchedule	否	-
TolerateScheduleType	String	否	- 示例值：NoSchedule
CustomTolerateSchedules	Array of CustomTolerateSchedule	否	-

ServiceConfig

服务配置

被如下接口引用：CreateApplication, DeployContainerApplication, DescribeApplication, ModifyApplication。

名称	类型	必选	描述
Name	String	是	服务名 示例值：java-demo
Ports	Array of Ports	是	端口信息列表
HealthCheck	HealthCheckConfig	否	健康检查配置

ServiceGovernanceConfig

注册配置治理信息

被如下接口引用：CreateApplication, DescribeApplication, ModifyApplication。

名称	类型	必选	描述
EnableGovernance	Boolean	否	是否开启服务注册治理 示例值：true
GovernanceType	String	否	服务治理类型（枚举：SHARE表示共享型、EXCLUSIVE表示独占型） 示例值：SHARE
ExclusiveInstances	Array of ExclusiveInstance	否	独享实例列表 注意：此字段可能返回 null，表示取不到有效值。

ServiceSetting

容器网络设置。

被如下接口引用：DeployContainerApplication, DeployContainerGroup, DescribeContainerGroupDeployInfo。

名称	类型	必选	描述
AccessType	Integer	是	0:公网, 1:集群内访问, 2：NodePort, 3: VPC 内网访问 示例值：2
ProtocolPorts	Array of ProtocolPort	是	容器端口映射
SubnetId	String	是	子网ID 示例值：subnet-d15zonly
DisableService	Boolean	否	是否创建 k8s service，默认为 false 示例值：false
HeadlessService	Boolean	否	service 是否为 headless 类型 示例值：false
AllowDeleteService	Boolean	否	当为 true 且 DisableService 也为 true 时，会删除之前创建的 service，请小心使用 示例值：false
OpenSessionAffinity	Boolean	否	开启SessionAffinity，true为开启，false为不开启，默认为false 示例值：false
SessionAffinityTimeoutSeconds	Integer	否	SessionAffinity会话时间，默认10800 示例值：10800
ServiceName	String	否	服务名称 示例值：svc-name
ExternalTrafficStrategy	String	否	外部流量策略 示例值：Local
ExternalTrafficPolicy	String	否	外部流量策略 示例值：Local
LoadBalancerProvisioner	String	否	负载均衡提供者 示例值：tgw
LoadBalancingType	String	否	负载均衡类型，Intranet表示内网，Internet表示外网 示例值：Intranet
ClusterIp	String	否	k8s负载均衡内网vip 示例值：192.168.21.2
DisableServiceInt	Integer	否	禁用服务Int记录 示例值：0
OpenSessionAffinityInt	Integer	否	开启SessionAffinity Int记录 示例值：0
HeadlessServiceInt	Integer	否	开启HeadlessService int记录 示例值：0
Name	String	否	服务名称 示例值：svc-name
VpcId	String	否	VPC网络ID 示例值：vpcid
LoadBalancingIp	String	否	负载均衡VIP 示例值：loadbalanceIp
LoadBalancerId	String	否	负载均衡id 示例值：loadbalanceId
ExistingLoadBalancerId	String	否	已存在的负载均衡id 示例值：existingLoadbalancerId

ServiceStatisticsResult

服务统计结果

被如下接口引用：DescribeStatistics。

名称	类型	描述
Path	String	请求模板路径:type为接口时返回，服务时不返回 示例值：/var/log
Method	String	请求方法:type为接口时返回，服务时不返回 示例值：findOne
MicroserviceId	String	微服务ID 示例值：ms-6a79x94v
MicroserviceName	String	微服务名称 示例值：java-service
RequestCount	Integer	请求数 示例值：19
ErrorRate	Float	请求错误率，不带百分号 示例值：12.0
AvgTimeConsuming	Float	平均响应耗时ms 示例值：100.0
MetricDataCurves	Array of MetricDataCurve	响应耗时曲线
InstanceId	String	实例id 示例值：ins-6a79x94v
InstanceName	String	实例name 示例值：java-ins
GroupId	String	部署组ID 示例值：group-6a79x94v
GroupName	String	部署组name 示例值：group-mock
ClusterType	String	集群类型，C：容器集群，V：虚拟机集群 示例值：C
GroupExist	Integer	部署组是否存在 示例值：1
InstanceExist	Integer	实例是否存在，仅限cvm 示例值：1
ApplicationId	String	应用ID 示例值：application-6a79x94v
MicroserviceType	String	微服务类型。RAW：裸应用，M：mesh应用，N：普通应用，G：网关应用 示例值：N
CpuPercent	Integer	cpu使用率 示例值：33
HeapUsed	Integer	已用堆大小,单位KB 示例值：16324
DbName	String	数据库 示例值：tsf_db_demo
Script	String	Script值 示例值：this is a script
DbType	String	数据库类型 示例值：mysql
Apdex	Float	Apdex值 示例值：2.0
Qps	Float	Qps值 示例值：89.0
InstanceOnlineCount	Integer	实例在线数 示例值：1
InstanceTotalCount	Integer	实例总数 示例值：3
Status	String	状态。normal：正常，warn：警告，error：错误 示例值：normal
ErrorRateLevel	String	请求错误率等级。normal：正常，warn：警告，error：错误 示例值：warn
AvgTimeConsumingLevel	String	请求平均耗时等级。normal：正常，warn：警告，error：错误 示例值：normal
ApdexLevel	String	应用程序性能指数等级。normal：正常，warn：警告，error：错误 示例值：normal

ServiceStatisticsResults

服务统计结果集

被如下接口引用：DescribeStatistics。

名称	类型	描述
Content	Array of ServiceStatisticsResult	返回结果
TotalCount	Integer	条数 示例值：20

ShardArgument

分片参数

被如下接口引用：CreateTask, DescribeTaskDetail, DescribeTaskRecords, ModifyTask。

名称	类型	必选	描述
ShardKey	Integer	否	分片参数 KEY，整形, 范围 [1,1000] 示例值：32
ShardValue	String	否	分片参数 VALUE 注意：此字段可能返回 null，表示取不到有效值。 示例值：1

SimpleApplication

简单应用

被如下接口引用：DescribeSimpleApplications。

名称	类型	描述
ApplicationId	String	应用ID 示例值：application-6a79x94v
ApplicationName	String	应用名称 示例值：java-app
ApplicationType	String	应用类型 示例值：C
MicroserviceType	String	应用微服务类型 示例值：N
ApplicationDesc	String	ApplicationDesc 示例值：this is a desc
ProgLang	String	ProgLang 示例值：J
ApplicationResourceType	String	ApplicationResourceType 示例值：C
CreateTime	String	CreateTime 示例值：2020-12-13 11:23:45
UpdateTime	String	UpdateTime 示例值：1728407923
ApigatewayServiceId	String	ApigatewayServiceId 示例值：gw-ins-6a79x94v
ApplicationRuntimeType	String	ApplicationRuntimeType 示例值：konaJdk8
AmpInstanceId	String	Apm业务系统id 示例值：apm-6a79x94v
ApmInstanceName	String	Apm业务系统Name 示例值：app-apm

SimpleGroup

部署组

被如下接口引用：DescribeSimpleGroups。

名称	类型	描述
GroupId	String	部署组ID 示例值：group-6a79x94v
GroupName	String	部署组名称 示例值：group-mock
ApplicationId	String	应用ID 示例值：application-6a79x94v
ApplicationName	String	应用名称 示例值：app
ApplicationType	String	应用类型 示例值：C
ClusterId	String	集群ID 示例值：cls-6a79x94v
ClusterName	String	集群名称 示例值：k8s-cls
ClusterType	String	集群类型 示例值：C
NamespaceId	String	命名空间ID 示例值：namespace-6a79x94v
NamespaceName	String	命名空间名称 示例值：namespace-name
StartupParameters	String	启动参数 示例值：-Xmx1024m -Xms256m
GroupResourceType	String	部署组资源类型 示例值：C
AppMicroServiceType	String	应用微服务类型 示例值：N
K8sNamespaceName	String	k8s 命名空间名称 示例值：kube-ns

SimpleKafkaDeliveryConfig

日志投递kafka配置描述的缩简版

被如下接口引用：DescribeDeliveryConfigByGroupId。

名称	类型	描述
ConfigId	String	配置项id 注意：此字段可能返回 null，表示取不到有效值。 示例值：config-6a79x94v
ConfigName	String	配置项名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：send_kafka_config

StdoutLogV2

标准输出日志

被如下接口引用：SearchStdoutLog。

名称	类型	描述
InstanceId	String	实例ID 示例值：ins-6a79x94v
Content	String	日志内容 示例值：log-xxxxxxxxxxxxxx
Timestamp	Integer	日志时间戳，单位毫秒 示例值：1754547960288
InstanceIp	String	实例IP 示例值：10.20.1.2

Tag

标签

被如下接口引用：CreateGroup, DeployContainerApplication, DescribeLicenses。

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

TaskFlowEdge

工作流图中的边

被如下接口引用：CreateTaskFlow。

名称	类型	必选	描述
NodeId	String	否	节点 ID，节点类型为任务时为任务ID，节点类型为逻辑节点"且"时为 AND，为逻辑节点"或"时为 OR，节点类型为头节点时为字符串"head" 示例值：head
ChildNodeId	String	否	子节点 ID，节点类型为任务时为任务ID，节点类型为逻辑节点"且"时为 AND，为逻辑节点"或"时为 OR 示例值：task-x8orm34b
CoreNode	String	否	是否核心任务,Y/N 示例值：N
EdgeType	String	否	边类型，上下游任务依赖触发关系。一共2个值，Y：成功触发，N：失败触发 示例值：Y
NodeType	String	否	任务节点类型，一共有4种类型，AND：逻辑节点且，OR：逻辑节点或，TASK：任务节点，START：头节点 示例值：START
PositionX	String	否	X轴坐标位置 示例值：12
PositionY	String	否	Y轴坐标位置 示例值：32
GraphId	String	否	图 ID，新建工作流时自动生成，不需要填写，查看工作流图时后端返回 示例值：graph-2p7d984g
FlowId	String	否	工作流 ID，新建工作流时自动生成，不需要填写，查看工作流图时后端返回 示例值：flow-2p7d984g
NodeName	String	否	节点名称 示例值：head
TaskId	String	否	任务ID，新建工作流时不需要填写，查看工作流图时后端返回 示例值：task-x8orm34b
TaskLogId	String	否	任务历史ID，新建工作流时不需要填写，查看工作流图时后端返回 示例值：tlog-x8orm34b

TaskFlowLastBatchState

工作流最近批次的状态

被如下接口引用：DescribeFlowLastBatchState。

名称	类型	描述
FlowBatchId	String	批次ID 示例值：fbatch-6a79x94v
FlowBatchLogId	String	批次历史ID 示例值：fblog-6a79x94v
State	String	状态,WAITING/SUCCESS/FAILED/RUNNING/TERMINATING 示例值：RUNNING

TaskId

任务id

被如下接口引用：DeployGroup, ExpandGroup, ShrinkGroup, ShrinkInstances, StartGroup, StopGroup。

名称	类型	描述
TaskId	String	任务ID 示例值：task-6a79x94v

TaskLastExecuteStatus

任务最近一次执行状态

被如下接口引用：DescribeTaskLastStatus。

名称	类型	描述
BatchId	String	批次ID 示例值：batch-6a79x94v
State	String	运行状态，RUNNING/SUCCESS/FAIL/HALF/TERMINATED 示例值：RUNNING
BatchLogId	String	批次历史ID 示例值：blog-6a79x94v

TaskRecord

任务定义

被如下接口引用：DescribeTaskDetail, DescribeTaskRecords。

名称	类型	描述
TaskName	String	任务名称 示例值：test-task
TaskType	String	任务类型 示例值：java
ExecuteType	String	任务执行方式，unicast：随机单节点执行，broadcast：广播执行，shard：分片执行 示例值：unicast
TaskContent	String	任务内容，长度限制65535字节 示例值：content
GroupId	String	分组ID 示例值：group-6a79x94v
TimeOut	Integer	超时时间，单位：毫秒。 示例值：30000
RetryCount	Integer	重试次数 示例值：2
RetryInterval	Integer	重试间隔，单位：毫秒。 示例值：20000
TaskRule	TaskRule	触发规则
TaskState	String	任务启用状态。一共2种状态可选，ENABLED：启用，DISABLED：停用 示例值：ENABLE
TaskId	String	任务ID 示例值：task-6a79x94v
SuccessOperator	String	判断任务成功的操作符 示例值：=
SuccessRatio	Integer	判断任务成功的阈值 示例值：100
ShardCount	Integer	分片数量 示例值：32
AdvanceSettings	AdvanceSettings	高级设置
ShardArguments	Array of ShardArgument	分片参数
BelongFlowIds	Array of String	所属工作流ID 示例值：["flow-6a79x94v"]
TaskLogId	String	任务历史ID 示例值：tlog-6a79x94v
TriggerType	String	触发类型，一共3种类型，WorkFlow：工作流触发，Cron：定时触发，FixRate：周期触发 示例值：WorkFlow
TaskArgument	String	任务参数，长度限制10000个字符 示例值：1,2,3,4,5

TaskRecordPage

翻页查询的任务记录返回

被如下接口引用：DescribeTaskRecords。

名称	类型	描述
TotalCount	Integer	总数量 示例值：21
Content	Array of TaskRecord	任务记录列表

TaskRule

任务规则

被如下接口引用：CreateTask, CreateTaskFlow, DescribeTaskDetail, DescribeTaskRecords, ModifyTask。

名称	类型	必选	描述
RuleType	String	是	触发规则类型，枚举值。一共3个值，Cron：定时触发，Repeat：周期触发，WorkFlow：工作流触发 示例值：Cron
Expression	String	否	Cron类型规则，cron表达式。 示例值：0 0/1 * * * ?
RepeatInterval	Integer	否	时间间隔， 单位毫秒 注意：此字段可能返回 null，表示取不到有效值。 示例值：0

TcrRepoInfo

tcr仓库信息

被如下接口引用：DeployContainerApplication, DescribeContainerGroupDeployInfo, DescribeImageRepository, DescribeImageTags, OperateApplicationTcrBinding。

名称	类型	必选	描述
Region	String	否	地域（填数字） 示例值：ap-guangzhou
RegistryId	String	否	实例id 示例值：reg-6a79x94v
RegistryName	String	否	实例名 示例值：/tsf
Namespace	String	否	命名空间 示例值：tsf_1083080xxxx
RepoName	String	否	仓库名 示例值：/tsf/nginx

ThreadPicture

jvm监控数据线程数据封装

被如下接口引用：DescribeJvmMonitor。

名称	类型	描述
ThreadCount	Array of CurvePoint	总线程数
ThreadActive	Array of CurvePoint	活跃线程数
DaemonThreadCount	Array of CurvePoint	守护线程数

TrySchedule

尽量调度

被如下接口引用：DeployContainerApplication, DeployContainerGroup。

名称	类型	必选	描述
AffinityList	Array of Affinity	否	-
AntiAffinityList	Array of Affinity	否	-

TsfApiListResponse

TsfApiListResponse

被如下接口引用：DescribeMsApiList。

名称	类型	描述
TotalCount	Integer	数量 注意：此字段可能返回 null，表示取不到有效值。 示例值：100
Content	Array of MsApiArray	API 列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：[{"Path":"/echo-feign/{str}","Method":"GET","Description":"This is desc","Status":1,"MsgwApiType":null,"RpcType":"http"}]

TsfConfigCenter

配置中心

被如下接口引用：DescribeFileConfigReleases, DescribeGroupRelease, ReleaseConfigWithDetailResp。

名称	类型	必选	描述
ConfigType	String	否	配置中心类型。 - SHARE：共享型 - EXCLUSIVE：独占型 注意：此字段可能返回 null，表示取不到有效值。 示例值：SHARE
ConfigCenterInstanceId	String	否	配置中心实例id 注意：此字段可能返回 null，表示取不到有效值。 示例值：ins-0e02e26d
ConfigCenterInstanceName	String	否	配置中心实例名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：lzmmm
RegionId	String	否	实例地域id 注意：此字段可能返回 null，表示取不到有效值。 示例值：33
NamespaceId	String	否	命名空间id 注意：此字段可能返回 null，表示取不到有效值。 示例值：namespace-byxkpkal
CurrentVersion	String	否	当前版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：1.18.0.0
TargetVersion	String	否	需要升级的版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：1.18.0.1

TsfPageApiDetailInfo

ApiDetailInfo 翻页对象

被如下接口引用：DescribeGatewayApis。

名称	类型	描述
TotalCount	Integer	总记录数 示例值：20
Content	Array of ApiDetailInfo	API 信息列表

TsfPageApiGroupInfo

ApiGroupInfo翻页结构体

被如下接口引用：DescribeApiGroups, DescribeGroupGateways, DescribeGroupsWithPlugin。

名称	类型	描述
TotalCount	Integer	总记录数 示例值：100
Content	Array of ApiGroupInfo	API分组信息

TsfPageApplication

应用分页信息

被如下接口引用：DescribeApplications。

名称	类型	描述
TotalCount	Integer	应用总数目 示例值：2
Content	Array of ApplicationForPage	应用信息列表
SpecTotalCount	Integer	获取部署组实例列表返回的原始批次个数 示例值：12

TsfPageBusinessLogConfig

业务日志配置项列表

被如下接口引用：DescribeBusinessLogConfigs, DescribeGroupBusinessLogConfigs。

名称	类型	描述
TotalCount	Integer	总条数 示例值：17
Content	Array of BusinessLogConfig	业务日志配置项列表

TsfPageBusinessLogV2

业务日志列表

被如下接口引用：SearchBusinessLog。

名称	类型	描述
TotalCount	Integer	总条数 示例值：21
Content	Array of BusinessLogV2	业务日志列表
ScrollId	String	游标ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：scroll-6a79x94v
Status	String	查询状态，SUCCESS：查询成功完成，ERROR_RANGE_EXCEED：查询范围过大异常，ERROR_COMPLEX_CONDITION：查询条件复杂异常，ERROR_OTHER_CAUSE：其他异常 注意：此字段可能返回 null，表示取不到有效值。 示例值：SUCCESS
SearchAfter	Array of String	查询es时，使用searchAfter返回的游标 示例值：["1463538857", "654323"]

TsfPageCluster

Tsf分页集群对象

被如下接口引用：DescribeSimpleClusters。

名称	类型	描述
TotalCount	Integer	总条数 示例值：21
Content	Array of Cluster	集群列表

TsfPageClusterV2

Tsf分页集群对象

被如下接口引用：DescribeClusters。

名称	类型	描述
TotalCount	Integer	集群总数目 示例值：21
Content	Array of ClusterV2	集群列表

TsfPageConfig

TsfPage<Config>

被如下接口引用：DescribeConfigSummary, DescribeConfigs, DescribePublicConfigSummary, DescribePublicConfigs。

名称	类型	描述
TotalCount	Integer	TsfPageConfig 示例值：100
Content	Array of Config	配置项列表

TsfPageConfigRelease

TSF配置项发布信息分页对象

被如下接口引用：DescribeConfigReleases, DescribePublicConfigReleases。

名称	类型	描述
TotalCount	Integer	总条数 注意：此字段可能返回 null，表示取不到有效值。 示例值：100
Content	Array of ConfigRelease	配置项发布信息数组 注意：此字段可能返回 null，表示取不到有效值。

TsfPageConfigReleaseLog

TSF配置项发布日志分页对象

被如下接口引用：DescribeConfigReleaseLogs, DescribePublicConfigReleaseLogs。

名称	类型	描述
TotalCount	Integer	总条数 注意：此字段可能返回 null，表示取不到有效值。 示例值：100
Content	Array of ConfigReleaseLog	配置项发布日志数组 注意：此字段可能返回 null，表示取不到有效值。

TsfPageContainerEvent

分页的 ContainerEvent

被如下接口引用：DescribeContainerEvents。

名称	类型	描述
TotalCount	Integer	返回个数 示例值：1
Content	Array of ContainerEvent	events 数组 示例值：[]

TsfPageDimension

维度分页

被如下接口引用：DescribeInvocationMetricDataDimension。

名称	类型	描述
TotalCount	Integer	总数 示例值：0
Content	Array of String	维度 示例值：["2","3"]

TsfPageFileConfig

文件配置项列表

被如下接口引用：DescribeFileConfigs。

名称	类型	描述
TotalCount	Integer	总数目 注意：此字段可能返回 null，表示取不到有效值。 示例值：100
Content	Array of FileConfig	文件配置数组 注意：此字段可能返回 null，表示取不到有效值。

TsfPageFileConfigRelease

文件配置项发布信息列表

被如下接口引用：DescribeFileConfigReleases。

名称	类型	描述
TotalCount	Integer	数量 示例值：100
Content	Array of FileConfigRelease	列表 示例值：[{"ConfigReleaseId":"dcfgr-f-vkjjw7ny","ConfigId":"dcfg-f-v3qqrkdy","ConfigVersion":"2","GroupId":"group-vj3n6lzy","NamespaceId":"namespace-ygo3djma","ClusterId":"cls-f6bk82xc","ApplicationId":"application-vw8ljmwv"}]

TsfPageGatewayDeployGroup

GatewayDeployGroup 翻页对象

被如下接口引用：DescribeGroupBindedGateways。

名称	类型	描述
TotalCount	Integer	记录总数 示例值：100
Content	Array of GatewayDeployGroup	记录实体列表 示例值：[{"DeployGroupId":"group-yd3b588a","DeployGroupName":"zuul","ApplicationId":"application-ydopqnxa","ApplicationName":"app-gw","ApplicationType":"V","GroupStatus":"Running","ClusterType":"V"}]

TsfPageGatewayPlugin

GatewayPlugin 翻页对象

被如下接口引用：DescribePluginInstances。

名称	类型	描述
TotalCount	Integer	记录总数 示例值：100
Content	Array of GatewayPlugin	记录实体列表 示例值：[{"Id":"pgn-iuyb0s7c","Name":"asd","Type":"OAuth","Description":"This is desc","CreatedTime":"2024-08-06 16:01:41","UpdatedTime":"2024-08-06 16:01:41","Status":"released"}]

TsfPageInstance

TSF机器实例分页对象

被如下接口引用：DescribeClusterInstances, DescribeGroupInstances。

名称	类型	描述
TotalCount	Integer	机器实例总数目 示例值：21
Content	Array of Instance	机器实例列表

TsfPageLicenseTag

LicenseTag 翻页对象

被如下接口引用：DescribeLicenses。

名称	类型	描述
TotalCount	Integer	记录总数 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
Content	Array of LicenseTag	记录实体列表 注意：此字段可能返回 null，表示取不到有效值。

TsfPageMicroservice

微服务列表信息

被如下接口引用：DescribeMicroservices, DescribeMicroservicesByGroupIds。

名称	类型	描述
TotalCount	Integer	微服务总数目 注意：此字段可能返回 null，表示取不到有效值。 示例值：100
Content	Array of Microservice	微服务列表信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：[{"MicroserviceId":"ms-vzge6mz8","NamespaceId":"namespace-v6b2exey","MicroserviceName":"consumer-demo","MicroserviceDesc":"This is desc","CreateTime":null,"UpdateTime":null,"RunInstanceCount":1,"CriticalInstanceCount":0}]

TsfPageMsInstance

微服务实例的分页内容

被如下接口引用：DescribeMicroservice。

名称	类型	描述
TotalCount	Integer	微服务实例总数目 注意：此字段可能返回 null，表示取不到有效值。 示例值：100
Content	Array of MsInstance	微服务实例列表内容 注意：此字段可能返回 null，表示取不到有效值。

TsfPageNamespace

Tsf命名空间分页对象

被如下接口引用：DescribeSimpleNamespaces。

名称	类型	描述
TotalCount	Integer	命名空间总条数 示例值：21
Content	Array of Namespace	命名空间列表

TsfPageSimpleApplication

TSF分页简单应用对象

被如下接口引用：DescribeSimpleApplications。

名称	类型	描述
TotalCount	Integer	总条数 示例值：21
Content	Array of SimpleApplication	简单应用列表

TsfPageSimpleGroup

TSF简单部署组分页列表

被如下接口引用：DescribeSimpleGroups。

名称	类型	描述
TotalCount	Integer	总条数 示例值：21
Content	Array of SimpleGroup	简单部署组列表

TsfPageStdoutLogV2

标准输出日志列表

被如下接口引用：SearchStdoutLog。

名称	类型	描述
TotalCount	Integer	总条数 示例值：21
Content	Array of StdoutLogV2	标准输出日志列表
ScrollId	String	游标ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：scroll-6a79x94v
Status	String	查询状态，SUCCESS：查询成功完成，ERROR_RANGE_EXCEED：查询范围过大异常，ERROR_COMPLEX_CONDITION：查询条件复杂异常，ERROR_OTHER_CAUSE：其他异常 注意：此字段可能返回 null，表示取不到有效值。 示例值：SUCCESS
SearchAfter	Array of String	查询es使用searchAfter时，游标 示例值：["1754547958821", "254107"]

TsfPageUnitNamespace

单元化命名空间翻页对象

被如下接口引用：DescribeUnitNamespaces, DescribeUsableUnitNamespaces。

名称	类型	描述
TotalCount	Integer	记录总数 示例值：100
Content	Array of UnitNamespace	记录实体列表

TsfPageUnitRule

单元化规则翻页对象

被如下接口引用：DescribeUnitRules。

名称	类型	描述
TotalCount	Integer	记录总数 示例值：100
Content	Array of UnitRule	记录实体列表

TsfPageUnitRuleV2

单元化规则翻页对象

被如下接口引用：DescribeUnitRulesV2。

名称	类型	描述
TotalCount	Integer	记录总数 示例值：100
Content	Array of UnitRule	记录实体列表 示例值：[{"Id":"unit-rl-cgdoi3wo","GatewayInstanceId":"gw-ins-szils128","UnitRuleItemList":[{"Id":"unit-item-dielh9rn","UnitRuleId":"unit-rl-cdcil6jo","UnitRuleTagList":[{"Id":"unit-tag-vmhijoic","UnitRuleItemId":"unit-item-ghpuh9rn"}]}]}]

TsfPageVmGroup

列表中部署组分页信息

被如下接口引用：DescribeGroups。

名称	类型	描述
TotalCount	Integer	虚拟机部署组总数目 示例值：21
Content	Array of VmGroupSimple	虚拟机部署组列表信息

UnitNamespace

微服务网关单元化命名空间

被如下接口引用：CreateUnitNamespaces, DescribeUnitNamespaces, DescribeUsableUnitNamespaces。

名称	类型	必选	描述
NamespaceId	String	是	命名空间ID 示例值：namespace-evjx6qyb
NamespaceName	String	是	命名空间Name 示例值：ns_app
Id	String	否	单元化命名空间ID 示例值：unit-ns-5boraz9n
GatewayInstanceId	String	否	网关实体ID 示例值：gw-ins-1lvbnrcc
CreatedTime	String	否	创建时间 示例值：2023-10-24 19:24:25
UpdatedTime	String	否	更新时间 示例值：2023-10-24 19:24:25

UnitRule

微服务网关单元化规则

被如下接口引用：CreateUnitRuleWithDetailResp, DescribeEnabledUnitRule, DescribeUnitRule, DescribeUnitRules, DescribeUnitRulesV2。

名称	类型	必选	描述
Name	String	是	规则名称 示例值：rule_app
Id	String	否	规则ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：unit-rl-6qeevdcd
GatewayInstanceId	String	否	网关实体ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：gw-ins-1lvbnrcc
Description	String	否	规则描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：This is desc
Status	String	否	使用状态：enabled/disabled 注意：此字段可能返回 null，表示取不到有效值。 示例值：disabled
UnitRuleItemList	Array of UnitRuleItem	否	规则项列表 注意：此字段可能返回 null，表示取不到有效值。
CreatedTime	String	否	CreatedTime 注意：此字段可能返回 null，表示取不到有效值。 示例值：2023-10-24 21:46:22
UpdatedTime	String	否	UpdatedTime 注意：此字段可能返回 null，表示取不到有效值。 示例值：2023-10-24 21:46:22

UnitRuleItem

微服务网关单元化规则项

被如下接口引用：CreateUnitRule, CreateUnitRuleWithDetailResp, DescribeEnabledUnitRule, DescribeUnitRule, DescribeUnitRulesV2, UpdateUnitRule。

名称	类型	必选	描述
Relationship	String	是	逻辑关系：AND/OR 示例值：AND
DestNamespaceId	String	是	目的地命名空间ID 示例值：namespace-6ymbkkvg
DestNamespaceName	String	是	目的地命名空间名称 示例值：ns_app
Name	String	是	规则项名称 示例值：unit_rule_app
Id	String	否	规则项ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：unit-item-1h36x2yt
UnitRuleId	String	否	单元化规则ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：unit-rl-8hsa450s
Priority	Integer	否	规则顺序，越小优先级越高：默认为0 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
Description	String	否	规则描述 注意：此字段可能返回 null，表示取不到有效值。 示例值：This is desc
UnitRuleTagList	Array of UnitRuleTag	否	规则标签列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：[{"Id":"unit-tag-vmhijoic","UnitRuleItemId":"unit-item-ghpuh9rn","TagType":"U","TagField":"user","TagOperator":"IN","TagValue":"1","ItemIndex":1,"CreatedTime":"2024-12-23 11:14:17","UpdatedTime":"2024-12-23 11:14:17"}]
ItemIndex	Integer	否	规则项索引 注意：此字段可能返回 null，表示取不到有效值。 示例值：1
CreatedTime	String	否	创建时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-12-23 11:14:17
UpdatedTime	String	否	修改时间 注意：此字段可能返回 null，表示取不到有效值。 示例值：2024-12-23 11:14:17

UnitRuleTag

微服务网关单元化规则标签

被如下接口引用：CreateUnitRule, CreateUnitRuleWithDetailResp, DescribeEnabledUnitRule, DescribeUnitRule, DescribeUnitRulesV2, UpdateUnitRule。

名称	类型	必选	描述
TagType	String	是	标签类型 : U(用户标签)/S(系统标签) 示例值：U
TagField	String	是	标签名 示例值：userId
TagOperator	String	是	操作符:IN/NOT_IN/EQUAL/NOT_EQUAL/REGEX 示例值：EQUAL
TagValue	String	是	标签值 示例值：1
UnitRuleItemId	String	否	单元化规则项ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：unit-item-uaji5qpr
Id	String	否	规则ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：unit-tag-6zpb4xrv

ValueFrom

k8s env 的 ValueFrom

被如下接口引用：DeployContainerApplication, DeployContainerGroup, DescribeContainerGroupDeployInfo。

名称	类型	必选	描述
FieldRef	FieldRef	否	k8s env 的 FieldRef
ResourceFieldRef	ResourceFieldRef	否	k8s env 的 ResourceFieldRef 注意：此字段可能返回 null，表示取不到有效值。
ConfigMapKeyRef	CommonRef	否	k8s env的configMapKeyRef
SecretKeyRef	CommonRef	否	k8s env 的 secretKeyRef

VmGroup

虚拟机部署组信息

被如下接口引用：DescribeGroup。

名称	类型	描述
GroupId	String	部署组ID 示例值：group-6a79x94v
GroupName	String	部署组名称 示例值：app-group
GroupStatus	String	部署组状态 示例值：running
PackageId	String	程序包ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：pkg-6a79x94v
PackageName	String	程序包名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：java-demo.jar
PackageVersion	String	程序包版本号 注意：此字段可能返回 null，表示取不到有效值。 示例值：latest
ClusterId	String	集群ID 示例值：cls-6a79x94v
ClusterName	String	集群名称 示例值：k8s-cls
NamespaceId	String	命名空间ID 示例值：namespace-6a79x94v
NamespaceName	String	命名空间名称 示例值：default
ApplicationId	String	应用ID 示例值：application-6a79x94v
ApplicationName	String	应用名称 示例值：app-java
InstanceCount	Integer	部署组机器数目 示例值：3
RunInstanceCount	Integer	部署组运行中机器数目 示例值：3
StartupParameters	String	部署组启动参数信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：-Xms256m -Xmx1024m
CreateTime	String	部署组创建时间 示例值：2020-12-12 11:34:56
UpdateTime	String	部署组更新时间 示例值：1677830374
OffInstanceCount	Integer	部署组停止机器数目 示例值：0
GroupDesc	String	部署组描述信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：this is a desc
MicroserviceType	String	微服务类型 示例值：DEF
ApplicationType	String	应用类型 示例值：C
GroupResourceType	String	部署组资源类型 示例值：C
UpdatedTime	Integer	部署组更新时间戳 示例值：1562739472
DeployDesc	String	部署应用描述信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：this is a desc
UpdateType	Integer	滚动发布的更新方式 示例值：1
DeployBetaEnable	Boolean	发布是否启用beta批次 示例值：false
DeployBatch	Array of Float	滚动发布的批次比例列表 示例值：0.25
DeployExeMode	String	滚动发布的批次执行方式 示例值：auto
DeployWaitTime	Integer	滚动发布的每个批次的等待时间 示例值：30
EnableHealthCheck	Boolean	是否开启了健康检查 示例值：false
HealthCheckSettings	HealthCheckSettings	健康检查配置 注意：此字段可能返回 null，表示取不到有效值。
PackageType	String	程序包类型 注意：此字段可能返回 null，表示取不到有效值。 示例值：jar
StartScript	String	启动脚本 base64编码 注意：此字段可能返回 null，表示取不到有效值。 示例值：this is a script
StopScript	String	停止脚本 base64编码 注意：此字段可能返回 null，表示取不到有效值。 示例值：this is a script
Alias	String	部署组备注 注意：此字段可能返回 null，表示取不到有效值。 示例值：备注
AgentProfileList	Array of AgentProfile	javaagent信息 示例值：SERVICE_AGENT/OT_AGENT
WarmupSetting	WarmupSetting	预热属性配置
GatewayConfig	GatewayConfig	Envoy网关配置 注意：此字段可能返回 null，表示取不到有效值。
EnableBatchHealthCheck	Boolean	批次是否开启健康检查 示例值：false
FilebeatCgroupEnable	Boolean	是否开启cgroup控制内存cpu 示例值：false
FilebeatMaxCpu	Float	filebeat使用cpu上限 示例值：0.1
FilebeatMaxMem	Integer	filebeat使用内存上限 示例值：100
RepositoryId	String	仓库ID 示例值：application-xxxx
RepositoryName	String	仓库名称 示例值：仓库名
RepositoryType	String	仓库类型 示例值：企业

VmGroupOther

虚拟机部署组其他字段

被如下接口引用：DescribeGroupAttribute。

名称	类型	描述
GroupId	String	部署组ID 示例值：group-6a79x94v
PackageId	String	程序包ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：pkg-6a79x94v
PackageName	String	程序包名称 注意：此字段可能返回 null，表示取不到有效值。 示例值：java-demo.jar
PackageVersion	String	程序包版本 注意：此字段可能返回 null，表示取不到有效值。 示例值：latest
InstanceCount	Integer	部署组实例数 示例值：3
RunInstanceCount	Integer	部署组运行中实例数 示例值：3
OffInstanceCount	Integer	部署组中停止实例数 示例值：0
GroupStatus	String	部署组状态，Running运行中，Waiting等待中，Paused暂停中，Updating更新中，RollingBack回滚中，Abnormal异常，Unknown未知 示例值：Running
IsNotEqualServiceConfig	Boolean	服务配置信息是否匹配 示例值：false
HealthCheckSettings	HealthCheckSettings	HealthCheckSettings 注意：此字段可能返回 null，表示取不到有效值。

VmGroupSimple

虚拟机部署组列表简要字段

被如下接口引用：DescribeGroups。

名称	类型	描述
GroupId	String	部署组ID 示例值：group-6a79x94v
GroupName	String	部署组名称 示例值：foo
ApplicationType	String	应用类型 示例值：C
GroupDesc	String	部署组描述 示例值：this is a desc
UpdateTime	String	部署组更新时间 示例值：176230473
ClusterId	String	集群ID 示例值：cls-6a79x94v
StartupParameters	String	部署组启动参数 示例值：-Xms256m -Xmx512m
NamespaceId	String	命名空间ID 示例值：namespace-6a79x94v
CreateTime	String	部署组创建时间 示例值：2020-12-23 12:34:56
ClusterName	String	集群名称 示例值：k8s-cls
ApplicationId	String	应用ID 示例值：application-6a79x94v
ApplicationName	String	应用名称 示例值：app-demo
NamespaceName	String	命名空间名称 示例值：default
MicroserviceType	String	应用微服务类型 示例值：DEF
GroupResourceType	String	部署组资源类型 示例值：C
UpdatedTime	Integer	部署组更新时间戳 示例值：17898792000
DeployDesc	String	部署应用描述信息 示例值：this is a desc
Alias	String	部署组备注 示例值：备注

VmInstanceResourceConfig

虚拟机实例相关的参数配置

被如下接口引用：DescribeResourceConfig。

名称	类型	描述
ImportMode	Array of String	实例导入方式，可多个，公有云为 ["R", "M"]，独立版的取值仅有 "M" 脚本模式 注意：此字段可能返回 null，表示取不到有效值。 示例值：["R"]

VolumeClaimTemplatesOption

VolumeClaim模板项

被如下接口引用：DeployContainerApplication, DeployContainerGroup, DescribeContainerGroupDeployInfo。

名称	类型	必选	描述
StorageClass	String	否	StorageClass名称 示例值：cbs
AccessModes	Array of String	否	访问模式 示例值：ReadWriteOnce
StorageRequest	Integer	否	卷空间的预占声明 示例值：20

VolumeInfo

容器卷挂载信息

被如下接口引用：DeployContainerApplication, DeployContainerGroup, DescribeContainerGroupDeployInfo。

名称	类型	必选	描述
VolumeType	String	是	数据卷类型 示例值：emptyDir
VolumeName	String	是	数据卷名称 示例值：config-path
VolumeConfig	String	否	数据卷配置 示例值：/host
ConfigMapOptions	Array of ConfigMapOption	否	-
EmptyDirOption	EmptyDirOption	否	-
VolumeClaimTemplateOption	VolumeClaimTemplatesOption	否	数据卷PVC声明模板

VolumeMountInfo

容器卷挂载点信息

被如下接口引用：DeployContainerApplication, DeployContainerGroup, DescribeContainerGroupDeployInfo。

名称	类型	必选	描述
VolumeMountName	String	是	挂载数据卷名称 示例值：config-name
VolumeMountPath	String	是	挂载路径 示例值：/host
VolumeMountSubPath	String	否	挂载子路径 示例值：/tsf
ReadOrWrite	String	否	读写，1：读 2：读写 示例值：2

WarmupSetting

预热配置

被如下接口引用：DeployContainerApplication, DeployContainerGroup, DeployGroup, DescribeContainerGroupDeployInfo, DescribeGroup。

名称	类型	必选	描述
Enabled	Boolean	否	是否开启预热 示例值：false
WarmupTime	Integer	否	预热时间，单位秒 示例值：120
Curvature	Integer	否	预热曲率，取值 1~5 示例值：2
EnabledProtection	Boolean	否	是否开启预热保护，在开启保护的情况下，超过 50% 的节点处于预热中，则会中止预热 示例值：false