文档首页

租户端互联网中间件微服务框架（TSF）数据结构

数据结构

最近更新时间: 2024-09-11 15:05:11

InstanceEnrichedInfo

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

被如下接口引用：DescribeInstances

名称	必选	允许NULL	类型	描述
InstanceId	是	是	String	机器ID
InstanceName	是	是	String	机器名称
LanIp	是	是	String	机器内网IP
WanIp	是	是	String	机器外网IP
VpcId	是	是	String	机器所在VPC
InstanceStatus	是	是	String	机器运行状态 Pending Running Stopped Rebooting Starting Stopping Abnormal Unknown
InstanceAvailableStatus	是	是	String	机器可用状态（表示机器上的Agent在线）
ApplicationId	是	是	String	应用ID
ApplicationName	是	是	String	应用名称
ApplicationType	是	是	String	应用类型
ClusterId	是	是	String	集群ID
ClusterName	是	是	String	集群名称
ClusterType	是	是	String	集群类型
NamespaceId	是	是	String	命名空间ID
NamespaceName	是	是	String	命名空间名称
GroupId	是	是	String	机器所在部署组ID
GroupName	是	是	String	部署组名称

TsfPageInvocationStatisticsV2

服务调用统计查询分页结果

被如下接口引用：DescribeInvocationStatistics

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总数量
Content	是	是	Array of InvocationStatisticsV2	内容列表

IpListResult

被如下接口引用：CreateServiceInstance

名称	必选	允许NULL	类型	描述
InstanceId	否	是	String	InstanceId
Ip	否	是	String	Ip
UserName	否	是	String	UserName
Password	否	是	String	Password
MachineId	否	是	String	machineId

FindContainerGroupResultV2

1.16 容器部署组详情(FindContainerGroup) Result

被如下接口引用：

名称	必选	允许NULL	类型	描述
GroupId	是	是	String	groupId
GroupName	是	是	String	分组名称
InstanceCount	是	是	Int64	实例总数
RunInstanceCount	是	是	Int64	已启动实例总数
CreateTime	是	是	String	创建时间
Server	是	是	String	镜像server
Reponame	是	是	String	镜像名，如/tsf/nginx
TagName	是	是	String	镜像版本名称
ClusterId	是	是	String	集群id
ClusterName	是	是	String	集群名称
NamespaceId	是	是	String	命名空间id
NamespaceName	是	是	String	命名空间名称
ApplicationId	是	是	String	应用id
ApplicationName	是	是	String	应用名称
ApplicationType	是	是	String	应用类型
LbIp	是	是	String	负载均衡ip
ClusterIp	是	是	String	Service ip
NodePort	是	是	String	NodePort端口，只有公网和NodePort访问方式才有值
CpuLimit	是	是	String	最大分配的 CPU 核数，对应 K8S limit
MemLimit	是	是	String	最大分配的内存 MiB 数，对应 K8S limit
AccessType	是	是	Int64	0:公网 1:集群内访问 2：NodePort
UpdateType	是	是	Int64	更新方式：0:快速更新 1:滚动更新
UpdateIvl	是	是	Int64	更新间隔,单位秒
ProtocolPorts	是	是	Array of ProtocolPort	端口数组对象
Envs	是	是	Array of Env	环境变量数组
CpuRequest	是	是	String	初始分配的 CPU 核数，对应 K8S request
MemRequest	是	是	String	初始分配的内存 MiB 数，对应 K8S request
SubnetId	是	是	String	子网id

SimpleClusterV2

简单集群

被如下接口引用：

名称	必选	允许NULL	类型	描述
ClusterId	是	是	String	集群ID
ClusterName	是	是	String	集群名称
ClusterType	是	是	String	集群类型

InstanceEnrichedInfoPage

InstanceEnrichedInfo列表结构

被如下接口引用：DescribeInstances

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Uint64	总数量
Content	是	是	Array of InstanceEnrichedInfo	列表

InterfaceRequest

单条接口请求详情

被如下接口引用：DescribeInterfaceRequest

名称	必选	允许NULL	类型	描述
TraceId	是	是	String	trace id
Timestamp	是	是	Int64	起始时间
Duration	是	是	Int64	耗时
ResultStatus	是	是	String	结果状态
ResultError	是	是	String	错误
InstanceInfo	是	是	InstanceInfo	实例信息

GroupListV2

部署组列表信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
GroupId	是	否	String	部署组id
GroupName	是	否	String	部署组名

Namespace

命名空间

被如下接口引用：DescribeNamespaces、DescribeSimpleNamespaces

名称	必选	允许NULL	类型	描述
NamespaceId	是	是	String	命名空间ID
NamespaceCode	是	是	String	命名空间编码
NamespaceName	是	是	String	命名空间名称
NamespaceDesc	是	是	String	命名空间描述
IsDefault	是	是	String	默认命名空间
NamespaceStatus	是	是	String	命名空间状态
DeleteFlag	是	是	Bool	删除标识
CreateTime	是	是	String	创建时间
UpdateTime	是	是	String	更新时间
ClusterList	是	是	Array of Cluster	集群数组，仅携带集群ID，集群名称，集群类型等基础信息。
ClusterId	是	是	String	集群ID
NamespaceResourceType	是	是	String	集群资源类型
NamespaceType	是	是	String	命名空间类型
IsHaEnable	是	是	String	是否开启高可用
ProgramId	否	是	String	数据集id

TsfPageMsRunningApplicationV2

微服务运行态应用分页列表对象

被如下接口引用：DescribeMsRunningApplications

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	运行微服务的应用个数
Content	是	是	Array of MsRunningApplicationV2	运行微服务的应用列表

ConsumerV2

Consumer

被如下接口引用：

名称	必选	允许NULL	类型	描述
ConsumerControllerName	是	是	String	ConsumerControllerName
ToProviderName	是	是	String	ToProviderName
ToProviderServiceName	是	是	String	ToProviderServiceName

GatewayWeChatMiniProgramLoginPlugin

微服务网关微信登录插件

被如下接口引用：DescribeGatewayWeChatMiniProgramLoginPlugin

名称	必选	允许NULL	类型	描述
Id	是	否	String	网关插件ID
Name	是	否	String	插件名称
Description	是	是	String	插件描述
Type	是	否	String	插件类型
CreatedTime	是	否	String	插件创建时间如:2019-06-20 15:51:28
UpdatedTime	是	否	String	插件更新时间如:2019-06-20 15:51:28
Status	是	否	String	发布状态: drafted/released
WeChatAppId	是	否	String	微信小程序AppId
RequestCodeBaggagePosition	是	否	String	微信小程序请求code携带位置：header/cookie
SessionKeyName	是	否	String	自定义登录态参数名
SessionExpireTime	是	否	Int64	自定义登录态过期时间，单位：秒
RequestSessionBaggagePosition	是	否	String	前台业务请求自定义登录态参数位置：header/cookie
BusinessSessionBaggagePosition	是	否	String	向业务后台传输登录态参数位置：header/query/cookie
ResponseSessionBaggagePosition	是	否	String	返回自定义登录态参数位置：header
MetaDataTagInfoList	是	是	String	元数据转标签配置的Json串
CustomizeTagInfoList	是	是	String	自定义标签配置的Json串

PortsResult

被如下接口引用：CreateServiceInstance、ListTsfModulesDetail

名称	必选	允许NULL	类型	描述
PortId	否	是	String	PortId值
PortType	否	是	String	PortType值
Port	否	是	String	Port值
DefaultPort	否	是	String	DefaultPort值
ModuleId	否	是	String	ModuleId值
EnableRegInConsul	否	是	Int64	EnableRegInConsul值

TsfPageUnitNamespace

单元化命名空间翻页对象

被如下接口引用：DescribeUnitNamespaces、DescribeUsableUnitNamespaces

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	记录总数
Content	是	否	Array of UnitNamespace	记录实体列表

TsfPageZipkinSpanInfoV2

调用链Span列表

被如下接口引用：GetOssTraceSpans

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总条目数
Content	是	是	Array of ZipkinSpanInfoV2	调用链Span列表

VmGroupOtherV2

虚拟机部署组其他字段

被如下接口引用：

名称	必选	允许NULL	类型	描述
GroupId	是	是	String	分组Id
PackageId	是	是	String	程序包Id
PackageName	是	是	String	程序包名称
PackageVersion	是	是	String	程序包版本
InstanceCount	是	是	Int64	分组实例数
RunInstanceCount	是	是	Int64	分组运行中实例数
OffInstanceCount	是	是	Int64	分组中停止实例数
GroupStatus	是	是	String	分组状态

CircuitBreakerStrategy

熔断策略

被如下接口引用：CreateCircuitBreakerRule、DescribeCircuitBreakerRule、DescribeCircuitBreakerRules、UpdateCircuitBreakerRule

名称	必选	允许NULL	类型	描述
StrategyId	否	否	String	熔断策略ID
RuleId	否	否	String	熔断策略所属熔断规则ID
MinimumNumberOfCalls	是	否	Int64	最少请求数
SlidingWindowSize	是	否	Int64	滚动窗口统计时间
WaitDurationInOpenState	是	否	Int64	熔断开启到半开间隔,单位s
FailureRateThreshold	否	是	Int64	失败请求比例
MaxEjectionPercent	否	是	Int64	最大熔断实例的比例
SlowCallDurationThreshold	否	是	Int64	慢请求阈值
SlowCallRateThreshold	否	是	Int64	慢请求比例
ApiList	否	是	Array of CircuitBreakerApi	熔断策略作用API

ManagerHttp

运营端透传http请求的入参类型

被如下接口引用：

名称	必选	允许NULL	类型	描述
Url	否	否	String	url
Body	否	否	String	body
Method	否	否	String	method

TsfPageContainerEvent

分页的 ContainerEvent

被如下接口引用：DescribeContainerEvents

名称	必选	允许NULL	类型	描述
TotalCount	否	否	Int64	返回个数
Content	否	否	Array of ContainerEvent	events 数组

TypeCode

术语描述对象，码表

被如下接口引用：DescribeRecordCodes

名称	必选	允许NULL	类型	描述
Code	是	否	String	术语英文描述
Name	是	否	String	术语中文描述

InstanceRequests

多条实例请求详情

被如下接口引用：DescribeInstanceRequest

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	内容
Content	是	是	Array of InstanceRequest	总条数

UploadInfo

上传包ID

被如下接口引用：UploadPkg

名称	必选	允许NULL	类型	描述
UploadId	是	是	String	上传包ID

Cluster

集群

被如下接口引用：DescribeClusterInstanceCount、DescribeNamespaces、DescribeSimpleClusters、DescribeSimpleNamespaces

名称	必选	允许NULL	类型	描述
ClusterId	是	是	String	集群ID
ClusterName	是	是	String	集群名称
ClusterDesc	是	是	String	集群描述
ClusterType	是	是	String	集群类型
VpcId	是	是	String	集群所属私有网络ID
ClusterStatus	是	是	String	集群状态
ClusterCIDR	是	是	String	集群CIDR
ClusterTotalCpu	是	是	Float	集群总CPU，单位: 核
ClusterTotalMem	是	是	Float	集群总内存，单位: G
ClusterUsedCpu	是	是	Float	集群已使用CPU，单位: 核
ClusterUsedMem	是	是	Float	集群已使用内存，单位: G
InstanceCount	是	是	Int64	集群机器实例数量
RunInstanceCount	是	是	Int64	集群可用的机器实例数量
NormalInstanceCount	是	是	Int64	集群正常状态的机器实例数量
DeleteFlag	是	是	Bool	删除标记：true：可以删除；false：不可删除
CreateTime	是	是	String	创建时间
UpdateTime	是	是	String	更新时间
TsfRegionId	是	是	String	集群所属TSF地域ID
TsfRegionName	是	是	String	集群所属TSF地域名称
TsfZoneId	是	是	String	集群所属TSF可用区ID
TsfZoneName	是	是	String	集群所属TSF可用区名称
DeleteFlagReason	是	是	String	集群不可删除的原因
ClusterLimitCpu	是	是	Float	集群最大CPU限制，单位：核
ClusterLimitMem	是	是	Float	集群最大内存限制，单位：G
RunServiceInstanceCount	是	是	Int64	集群可用的服务实例数量
SubnetId	是	是	String	集群所属子网ID
OperationInfo	是	是	OperationInfo	返回给前端的控制信息
ClusterVersion	是	是	String	集群版本

LaneRule

泳道规则

被如下接口引用：DescribeLaneRule、DescribeLaneRules

名称	必选	允许NULL	类型	描述
RuleId	是	是	String	泳道规则ID
RuleName	是	是	String	泳道规则名称
Priority	是	是	Int64	优先级
Remark	是	是	String	备注
RuleTagList	是	是	Array of LaneRuleTag	泳道规则标签列表
RuleTagRelationship	是	是	String	泳道规则标签关系
LaneId	是	是	String	泳道ID
Enable	是	是	Bool	开启状态
CreateTime	是	是	Int64	创建时间
UpdateTime	是	是	Int64	更新时间

LaneInfo

泳道

被如下接口引用：DescribeGroupLane、DescribeLane、DescribeLanes、DisableLaneGroupEntrance

名称	必选	允许NULL	类型	描述
LaneId	是	是	String	泳道ID
LaneName	是	是	String	泳道名称
Remark	是	是	String	泳道备注
CreateTime	是	是	Int64	创建时间
UpdateTime	是	是	Int64	更新时间
LaneGroupList	是	是	Array of LaneGroup	泳道部署组
Entrance	是	是	Bool	是否入口应用
NamespaceIdList	是	是	Array of String	泳道已经关联部署组的命名空间列表

ProtocolPort

端口对象

被如下接口引用：CreateContainGroup、DeployContainerGroup、DescribeContainerGroupDeployInfo、DescribeContainerGroupDetail、DescribeDeployGroup、DescribeSingleContainerGroups、FindContainerGroup、GetContainGroupDeployInfo、ModifyContainerGroup、UpdateContainerGroup

名称	必选	允许NULL	类型	描述
Protocol	是	否	String	TCP UDP
Port	是	否	Int64	服务端口
TargetPort	是	否	Int64	容器端口
NodePort	否	是	Int64	主机端口

RepositoryInfo

仓库信息

被如下接口引用：DescribeRepositories、DescribeRepository

名称	必选	允许NULL	类型	描述
RepositoryId	是	否	String	仓库ID
RepositoryName	是	是	String	仓库名称
RepositoryType	是	是	String	仓库类型（默认仓库：default，私有仓库：private）
RepositoryDesc	是	是	String	仓库描述
IsUsed	是	是	Bool	仓库是否正在被使用
CreateTime	是	是	String	仓库创建时间
BucketName	是	是	String	仓库桶名称
BucketRegion	是	是	String	仓库桶所在地域
Directory	是	是	String	仓库目录

ImageUserIsExistsResultV2

ImageUserIsExistsResult

被如下接口引用：

名称	必选	允许NULL	类型	描述
Data	是	是	ImageUserIsExists	用户是否存在

FindContainerGroupResult

1.16 容器部署组详情(FindContainerGroup) Result

被如下接口引用：FindContainerGroup

名称	必选	允许NULL	类型	描述
GroupId	是	是	String	groupId
GroupName	是	是	String	分组名称
InstanceCount	是	是	Int64	实例总数
RunInstanceCount	是	是	Int64	已启动实例总数
CreateTime	是	是	String	创建时间
Server	是	是	String	镜像server
Reponame	是	是	String	镜像名，如/tsf/nginx
TagName	是	是	String	镜像版本名称
ClusterId	是	是	String	集群id
ClusterName	是	是	String	集群名称
NamespaceId	是	是	String	命名空间id
NamespaceName	是	是	String	命名空间名称
ApplicationId	是	是	String	应用id
ApplicationName	是	是	String	应用名称
ApplicationType	是	是	String	应用类型
LbIp	是	是	String	负载均衡ip
ClusterIp	是	是	String	Service ip
NodePort	是	是	String	NodePort端口，只有公网和NodePort访问方式才有值
CpuLimit	是	是	String	最大分配cpu 核数，如0.6
MemLimit	是	是	String	最大分配内存M数
AccessType	是	是	Int64	0:公网 1:集群内访问 2：NodePort
UpdateType	是	是	Int64	更新方式：0:快速更新 1:滚动更新
UpdateIvl	是	是	Int64	更新间隔,单位秒
ProtocolPorts	是	是	Array of ProtocolPort	端口数组对象
Envs	是	是	Array of Env	环境变量数组
CpuRequest	是	是	String	初始分配的 CPU 核数，对应 K8S request
MemRequest	是	是	String	初始分配的内存 MiB 数，对应 K8S request
SubnetId	是	是	String	子网id

MonitorStatisticsPolicy

被如下接口引用：DescribeMonitorStatisticsPolicy、ListMonitorStatisticsPolicy

名称	必选	允许NULL	类型	描述
PolicyId	是	是	String	监控统计策略id
KeyWords	是	是	String	关键词
GroupList	是	是	Array of MonitorStatisticsPolicyGroup	部署组列表信息
NamespaceId	是	是	String	命名空间id
CreateTime	是	是	String	创建时间
UpdateTime	是	是	String	更新时间

ContainerInstanceResourceConfig

容器实例相关的参数配置

被如下接口引用：DescribeResourceConfig

名称	必选	允许NULL	类型	描述
ImportMode	是	是	Array of String	实例导入方式，可多个，公有云为 ["R"]，独立版的取值有 "M" 脚本模式、"S" SSH 模式
MasterNumLimit	是	是	Int64	SSH 模式时，前端应该限制用户填这个数量的 master 主机信息
NodeNumLimitPerSetup	是	是	Int64	SSH 模式时，前端应该限制用户填的最高数量的 node 主机信息

TsfPageZone

TSF可用区列表对象

被如下接口引用：DescribeTsfZones

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	TSF可用区总数目
Content	是	是	Array of TsfZone	TSF可用区列表

ListAlarmReceiverResult

被如下接口引用：ListAlarmReceivers

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	TotalCount
Content	是	是	Array of AlarmReceiverResult	Content

AlarmOverviewContent

告警记录概览页信息

被如下接口引用：DescribeAlarmOverviewList

名称	必选	允许NULL	类型	描述
MetricName	是	否	String	展示给前端的告警记录的指标名
RestoredNums	是	否	Int64	该告警指标24小时内，已恢复的告警条数
UnRestoredNums	是	否	Int64	该告警指标24小时内，未恢复的告警条数

AddInstanceResult

添加实例到集群的结果

被如下接口引用：AddClusterInstances

名称	必选	允许NULL	类型	描述
FailedInstanceIds	是	是	Array of String	添加集群失败的节点列表
SuccInstanceIds	是	是	Array of String	添加集群成功的节点列表
TimeoutInstanceIds	是	是	Array of String	添加集群超时的节点列表
FailedReasons	是	是	Array of String	失败的节点的失败原因

EventPolicyResult

被如下接口引用：CreateAlarmPolicy、DescribeAlarmPolicy、ListAlarmPolicies、ModifyAlarmPolicy

名称	必选	允许NULL	类型	描述
TriggerCondition	否	是	Int64	TriggerCondition
Frequency	否	是	Int64	Frequency
EventPolicyId	否	是	String	EventPolicyId
PolicyId	否	是	String	PolicyId

LaneRules

泳道规则分页查询

被如下接口引用：DescribeLaneRules

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	总数
Content	是	否	Array of LaneRule	泳道规则列表

TaskFlowBatchEdge

工作流执行批次的图信息

被如下接口引用：DescribeFlowBatchGraph

名称	必选	允许NULL	类型	描述
FlowId	是	否	String	工作流 ID
FlowBatchId	是	否	String	工作流批次 ID
FlowBatchLogId	是	否	String	工作流批次历史 ID
BatchId	是	是	String	批次 ID
BatchLogId	是	是	String	批次历史 ID
GraphId	是	否	String	图 ID
NodeId	是	否	String	节点 ID
ChildNodeId	是	是	String	子节点 ID
CoreNode	是	是	String	是否核心节点
NodeName	是	是	String	节点名称
EdgeType	是	是	String	边节点类型
NodeType	是	是	String	节点类型
SuccessRatio	是	是	Int64	节点执行成功率
PositionX	是	是	String	X轴坐标
PositionY	是	是	String	Y轴坐标
State	是	是	String	节点状态
TaskId	是	是	String	任务节点ID
TaskLogId	是	是	String	任务节点历史ID

TaskRecord

任务定义

被如下接口引用：DescribeTaskDetail、DescribeTaskRecords

名称	必选	允许NULL	类型	描述
TaskName	是	否	String	任务名称
TaskType	是	否	String	任务类型
ExecuteType	是	否	String	执行类型
TaskContent	否	否	String	任务内容，长度限制65535字节
GroupId	否	否	String	分组ID
TimeOut	是	否	Int64	超时时间
RetryCount	否	是	Int64	重试次数
RetryInterval	否	是	Int64	重试间隔
TaskRule	是	否	TaskRule	触发规则
TaskState	是	否	String	是否启用任务,ENABLED/DISABLED
TaskId	是	否	String	任务ID
SuccessOperator	是	是	String	判断任务成功的操作符
SuccessRatio	是	是	Int64	判断任务成功的阈值
ShardCount	是	是	Int64	分片数量
AdvanceSettings	是	是	AdvanceSettings	高级设置
ShardArguments	是	是	Array of ShardArgument	分片参数
BelongFlowIds	是	是	Array of String	所属工作流ID
TaskLogId	是	是	String	任务历史ID
TriggerType	是	是	String	触发类型
TaskArgument	是	是	String	任务参数，长度限制10000个字符

RealtimeLogSet

实时日志查询结果集合

被如下接口引用：SearchOssRealtimeBusinessLog、SearchRealtimeBusinessLog、SearchRealtimeMeshLog、SearchRealtimeStdoutLog

名称	必选	允许NULL	类型	描述
RealtimeTs	是	否	Uint64	请求基准时间戳（用于下次调用）
BusinessLogSet	是	是	TsfPageBusinessLogV2	业务日志集合
StdoutLogSet	是	是	TsfPageStdoutLogV2	标准输出日志集合
MeshLogSet	是	是	TsfPageMeshLog	Meh日志集合

ZipkinTraceInfo

调用链信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
TraceId	是	是	String	调用链ID
Timestamp	是	是	Uint64	调用链时间戳
Duration	是	是	Uint64	调用链时耗
ResultStatus	是	是	String	调用链结果

FileConfigRelease

文件配置项发布信息

被如下接口引用：DescribeFileConfigReleases

名称	必选	允许NULL	类型	描述
ConfigReleaseId	否	是	String	配置项发布ID
ConfigId	否	是	String	配置项ID
ConfigName	否	是	String	配置项名称
ConfigVersion	否	是	String	配置项版本
ReleaseDesc	否	是	String	发布描述
ReleaseTime	否	是	String	发布时间
GroupId	否	是	String	部署组ID
GroupName	否	是	String	部署组名称
NamespaceId	否	是	String	命名空间ID
NamespaceName	否	是	String	命名空间名称
ClusterId	否	是	String	集群ID
ClusterName	否	是	String	集群名称

RouteReleaseHistoryV2

路由规则启停记录

被如下接口引用：

名称	必选	允许NULL	类型	描述
RouteReleaseLogId	是	是	String	路由规则发布记录ID
MicroserviceId	是	是	String	微服务ID
RouteRuleId	是	是	String	路由规则ID
EnableTime	是	是	String	路由规则部署开始时间
DisableTime	是	是	String	路由规则停止时间
ReleaseDesc	是	是	String	路由规则发布
RouteRule	是	是	RouteV2	路由规则详情
AppId	是	是	String	账号APPID
Uin	是	是	String	账号Owner用户唯一ID
SubAccountUin	是	是	String	账号用户唯一ID

TsfPageFileConfigReleaseLog

文件配置项发布日志列表

被如下接口引用：DescribeFileConfigReleaseLogs

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	数量
Content	是	是	Array of FileConfigReleaseLog	列表

ExpandSubrule

被如下接口引用：DescribeScalableRuleAttribute

名称	必选	允许NULL	类型	描述
Indicators	是	是	Int64	Indicators
IndicatorType	是	是	Int64	IndicatorType
RuleType	是	是	Int64	RuleType

JvmLog

Jvm日志查询时每行日志详情封装

被如下接口引用：DescribeJvmLogs

名称	必选	允许NULL	类型	描述
Content	是	是	String	日志内容
InstanceIp	是	是	String	实例ip
InstanceId	是	是	String	实例id
Timestamp	是	是	String	日志产生的时间戳
GroupId	是	是	String	部署组Id

ShardArgument

分片参数

被如下接口引用：CreateTask、DescribeTaskDetail、DescribeTaskExecuteShardArgument、DescribeTaskRecords、ModifyTask

名称	必选	允许NULL	类型	描述
ShardKey	是	否	Uint64	分片参数 KEY，整形, 范围 [1,1000]
ShardValue	是	是	String	分片参数 VALUE

VolumeMountInfo

容器卷挂载点信息

被如下接口引用：DeployContainerGroup

名称	必选	允许NULL	类型	描述
VolumeMountName	是	否	String	挂载数据卷名称
VolumeMountPath	是	否	String	挂载路径
VolumeMountSubPath	否	否	String	挂载子路径
ReadOrWrite	否	否	String	读写，1：读 2：读写

GroupPodResult

部署组实例列表

被如下接口引用：DescribePodInstances

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总记录数
Content	是	是	Array of GroupPod	列表信息

MetricDimension

指标维度

被如下接口引用：DescribeInvocationMetricDataCurve

名称	必选	允许NULL	类型	描述
Name	否	是	String	指标维度名称
Value	否	是	String	指标维度取值

OverviewHostResourceUsage

TSF实例相关基本信息概览

被如下接口引用：DescribeHostResourceUsage

名称	必选	允许NULL	类型	描述
RunHostCount	是	是	Int64	运行云主机数
HostCount	是	是	Int64	云主机总数

TsfPageConfigSummaryV2

TsfPage<Config>

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	总条数
Content	是	否	Array of ConfigSummary	配置项列表

ContainerTasks

变更记录任务

被如下接口引用：DescribeContainerTasks

名称	必选	允许NULL	类型	描述
TaskId	是	是	String	taskId
TaskTime	是	是	String	任务开始时间
Type	是	是	Int64	任务类型字段，0：没有任务（在此接口中，不用出现0），1：发布程序包；2.部署操作；3.扩容操作；4.启动操作；5.停止操作；6.缩容操作；7.发布日志配置,8.删除销毁操作
Status	是	是	Int64	变更状态，0：成功 1:失败 2：执行中
GroupId	是	是	String	分组id
GroupName	是	是	String	分组名称
ImageName	是	是	String	镜像名称
ImageVersion	是	是	String	镜像版本
TaskDesc	是	是	String	任务详情描述
TotalCount	是	是	Int64	任务总个数
SuccessCount	是	是	Int64	成功任务个数
FailCount	是	是	Int64	失败任务个数

DescribeApplicationsOtherResultV2

应用列表其它字段

被如下接口引用：

名称	必选	允许NULL	类型	描述
InstanceCount	是	是	Int64	总实例个数
RunInstanceCount	是	是	Int64	运行实例个数

TsfPageConfigRelease

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

被如下接口引用：DescribeConfigReleases、DescribePublicConfigReleases

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总条数
Content	是	是	Array of ConfigRelease	配置项发布信息数组

ApiUseStatisticsEntity

API 日统计数据点

被如下接口引用：DescribeApiUseDetail

名称	必选	允许NULL	类型	描述
Name	是	否	String	名称
Count	是	否	String	次数
Ratio	是	否	String	比率

AuthCondition

用于 TSF 服务鉴权，表示鉴权条件

被如下接口引用：DescribeAuthorizationInfo、ModifyAuthorizationInfo

名称	必选	允许NULL	类型	描述
Type	是	否	String	类型，meta 或者 tag；条件为服务名时用 meta，其他用 tag
Key	是	否	String	条件为服务名时，key 为 sourceServiceId；条件是 tag 时，key 为用户自定义
Operator	是	否	String	操作符，从中选其一，equal, notEqual, in, notIn, regex
ValueList	是	是	Array of String	如果操作符不是 in / notIn，值只有一个
SourceServiceList	否	是	Array of AuthMicroservice	如果条件是服务名，在回包中这个数组中包含主调服务信息

GatewayTagPlugin

微服务网关TAG插件明细

被如下接口引用：DescribeGatewayTagPlugin

名称	必选	允许NULL	类型	描述
Id	是	否	String	网关插件id
Name	是	是	String	插件名称
Description	是	是	String	插件描述
Type	是	是	String	插件类型
CreatedTime	是	是	String	插件创建时间如:2019-06-20 15:51:28
UpdatedTime	是	是	String	插件更新时间如:2019-06-20 15:51:28
Status	是	是	String	发布状态: drafted/released
TagPluginInfoList	是	是	String	参数配置json串

GatewayDeployGroup

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

被如下接口引用：DescribeApiGroup、DescribeApiGroups、DescribeGroupBindedGateways、DescribeGroupGateways、DescribeGroupsWithPlugin、DescribeUsableGatewayGroups

名称	必选	允许NULL	类型	描述
DeployGroupId	是	是	String	网关部署组ID
DeployGroupName	是	是	String	网关部署组名称
ApplicationId	是	是	String	应用ID
ApplicationName	是	是	String	应用名称
ApplicationType	是	是	String	应用分类：V：虚拟机应用，C：容器应用
GroupStatus	是	是	String	部署组应用状态,取值: Running、Waiting、Paused、Updating、RollingBack、Abnormal、Unknown
ClusterType	是	是	String	集群类型，C ：容器，V：虚拟机

ImageRepositorySecret

镜像仓库密钥

被如下接口引用：DescribeSecretList

名称	必选	允许NULL	类型	描述
Id	否	是	String	凭证ID
SecretName	否	是	String	凭证名称
RepositoryDomain	否	是	String	镜像仓库域名
GroupId	否	是	String	部署组ID
Username	否	是	String	登录用户名
Password	否	是	String	登录密码
AuthType	否	是	String	认证类型，默认-"kubernetes.io/dockercfg"
AuthData	否	是	Array of AuthDataMap	认证数据

StatisticsEntryV2

概览页统计列表条目

被如下接口引用：

名称	必选	允许NULL	类型	描述
PrimeKey	是	是	String	主字段
SubKey	是	是	String	附字段
Value	是	是	String	值

TaskExecuteHistoryRecordPage

任务执行记录的流水列表

被如下接口引用：DescribeTaskExecuteHistoryRecords

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	分页总数
Content	是	否	Array of TaskExecuteHistoryRecord	分页对象

StdoutLogV2

标准输出日志

被如下接口引用：SearchOssRealtimeBusinessLog、SearchRealtimeBusinessLog、SearchRealtimeMeshLog、SearchRealtimeStdoutLog、SearchStdoutLog

名称	必选	允许NULL	类型	描述
InstanceId	是	是	String	实例ID
Content	是	是	String	日志内容
Timestamp	是	是	Uint64	日志时间戳
InstanceIp	是	是	String	实例IP

BusinessLogV2

业务日志

被如下接口引用：SearchBusinessLog、SearchOssBusinessLog、SearchOssRealtimeBusinessLog、SearchOssSpanBusinessLog、SearchOssStaticBusinessLog、SearchOssSurroundBusinessLog、SearchRealtimeBusinessLog、SearchRealtimeMeshLog、SearchRealtimeStdoutLog、SearchSpanBusinessLog、SearchSurroundBusinessLog

名称	必选	允许NULL	类型	描述
InstanceId	是	是	String	实例ID
Content	是	是	String	日志内容
Timestamp	是	是	Uint64	日志时间戳
InstanceIp	是	是	String	实例IP
LogId	是	是	String	日志ID
GroupId	是	是	String	部署组ID

TsfZoneResult

可用区信息

被如下接口引用：DescribeTsfmanagerZones、DescribeZones

名称	必选	允许NULL	类型	描述
TZoneId	否	是	String	tZoneId
TZoneName	否	是	String	tZoneName
TRemark	否	是	String	tRemark
TRegionId	否	是	String	tRegionId

GroupInfo

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

被如下接口引用：AssociateConfigWithGroup、DescribeAssociateRelation、DescribeDeliveryConfigs

名称	必选	允许NULL	类型	描述
GroupId	是	否	String	部署组id
GroupName	是	否	String	部署组名称
ClusterId	否	是	String	集群id
ClusterName	否	是	String	集群名称
ClusterType	是	否	String	集群类型
NamespaceName	否	是	String	命名空间名称
AssociateTime	否	是	String	绑定时间

GroupsByScalableRuleIdV2

GroupsByScalableRuleId

被如下接口引用：

名称	必选	允许NULL	类型	描述
ApplicationId	是	是	String	ApplicationId
ApplicationName	是	是	String	ApplicationName
GroupId	是	是	String	GroupId
GroupName	是	是	String	GroupName
Status	是	是	Int64	Status
UpdateTime	是	是	String	UpdateTime
RuleId	是	是	String	弹性伸缩规则id

UnitRuleTag

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

被如下接口引用：CreateUnitRule、DescribeEnabledUnitRule、DescribeUnitRule、DescribeUnitRules、UpdateUnitRule

名称	必选	允许NULL	类型	描述
UnitRuleItemId	否	是	String	单元化规则项ID
Id	否	是	String	规则ID
TagType	是	否	String	标签类型 : U(用户标签)
TagField	是	否	String	标签名
TagOperator	是	否	String	操作符:IN/NOT_IN/EQUAL/NOT_EQUAL/REGEX
TagValue	是	否	String	标签值

TagRouteItemList

标签路由规则

被如下接口引用：CreateRouteRule、DescribeRouteReleaseHistory、DescribeRouteRule、DescribeRouteRules、ModifyRouteRule

名称	必选	允许NULL	类型	描述
TagRouteId	否	否	String	标签路由规则项Id
SourceType	是	否	String	标签路由，标签类型，表示系统标签或自定义标签, 系统标签： S, 自定义标签： U
SourceField	是	否	String	标签路由匹配源字段
SourceMatchRule	是	否	String	标签路由匹配源规则, 等于: EQUAL，不等于： NOT_EQUAL，包含： IN，不包含： NOT_IN，正则表达式： REGEX
SourceValue	是	否	String	标签路由匹配源取值
TargetField	是	否	String	标签路由匹配目标字段
TargetValue	是	否	String	标签路由匹配目标取值
RouteRuleId	否	否	String	标签路由所属路由Id

AppPkgInfo

应用的包信息

被如下接口引用：ListAppPkg

名称	必选	允许NULL	类型	描述
ApplicationId	是	是	String	应用ID
PkgCount	是	是	Int64	应用下的程序包数量

TaskFlowLog

工作流修改历史流水

被如下接口引用：DescribeTaskFlow

名称	必选	允许NULL	类型	描述
FlowLogId	是	否	String	批次历史 ID
TaskCount	是	是	Int64	工作流中任务数量
FlowId	是	否	String	工作流历史 ID
State	是	是	String	工作流可用状态
FlowName	是	是	String	工作流名称
TriggerRule	是	是	TaskRule	触发规则
GraphId	是	是	String	工作流对应的图 ID
TimeOut	是	是	Int64	超时时间

ApiInfo

微服务网关API信息

被如下接口引用：CreateGatewayApi

名称	必选	允许NULL	类型	描述
NamespaceId	是	否	String	命名空间Id，若为外部API,为固定值："namespace-external"
MicroserviceId	是	否	String	服务Id，若为外部API,为固定值："ms-external"
Path	是	否	String	API path
Method	是	否	String	Api 请求
PathMapping	是	否	String	请求映射
Host	否	否	String	api所在服务host,限定外部Api填写。格式: `http://127.0.0.1:8080`
Description	否	否	String	api描述信息

ZipkinAnnotation

调用链Span注解

被如下接口引用：GetTraceSpans

名称	必选	允许NULL	类型	描述
Value	是	是	String	注解值
Timestamp	是	是	Uint64	注解时间戳
Endpoint	是	是	ZipkinEndPoint	注解端点信息

HealthCheckSettings

健康检查参数

被如下接口引用：DeployContainerGroup、DeployGroup、DescribeContainerGroupDeployInfo、DescribeContainerGroupDetail、DescribeGroup、UpdateHealthCheckSettings

名称	必选	允许NULL	类型	描述
LivenessProbe	否	是	HealthCheckSetting	存活健康检查
ReadinessProbe	否	是	HealthCheckSetting	就绪健康检查

TsfPageSimpleClusterV2

TSF分页简单集群

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总条数
Content	是	是	Array of SimpleCluster	简单集群列表

TsfPageClusterV3

Tsf分页集群对象

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Uint64	集群总数目
Content	是	是	ClusterV3	集群列表

CosUploadInfo

cos上传所需信息

被如下接口引用：CheckUploadInfo、DescribeUploadInfo、GetUploadInfo

名称	必选	允许NULL	类型	描述
PkgId	是	是	String	程序包ID
Bucket	是	是	String	桶
Region	是	是	String	目标地域
Path	是	是	String	存储路径
Credentials	是	否	CosCredentials	鉴权信息

ImageTagsV2

列表信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
RepoName	是	否	String	仓库名
TagName	是	否	String	版本名称
TagId	是	否	String	版本ID
ImageId	是	否	String	镜像ID
Size	是	否	String	大小
CreationTime	是	否	String	创建时间
UpdateTime	是	否	String	更新时间
Author	是	否	String	镜像制作者
Architecture	是	否	String	CPU架构
DockerVersion	是	否	String	Docker客户端版本
Os	是	否	String	操作系统
PushTime	是	否	String	push时间
SizeByte	是	否	Int64	单位为字节

TsfPageMicroserviceGroup

微服务下部署组列表

被如下接口引用：DescribeMicroserviceGroups

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	数据总数
Content	是	是	Array of MicroserviceGroup	翻页数据

DescribeResourceConfigLicenseResource

DescribeResourceConfig

被如下接口引用：DescribeResourceConfig

名称	必选	允许NULL	类型	描述
Name	是	是	String	Name
Quota	是	是	Uint64	Quota

TsfPageVmTask

虚拟机任务分页信息

被如下接口引用：DscribeTasks

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	任务总数目
Content	是	是	Array of VmTask	任务详情列表

CurvePoint

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

被如下接口引用：DescribeJvmMonitor

名称	必选	允许NULL	类型	描述
Label	是	否	String	当前坐标 X轴的值当前是日期格式:"yyyy-MM-dd HH:mm:ss"
Value	是	否	String	当前坐标 Y轴的值
Timestamp	是	否	String	该坐标点时间戳

TsfPageConfigV2

TsfPage<Config>

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	TsfPageConfig
Content	是	否	Array of Config	配置项列表

ConfigTemplate

配置模板对象

被如下接口引用：DescribeConfigTemplate、DescribeConfigTemplates

名称	必选	允许NULL	类型	描述
ConfigTemplateId	否	是	String	配置模板Id
ConfigTemplateName	否	是	String	配置模板名称
ConfigTemplateDesc	否	是	String	配置模板描述
ConfigTemplateType	否	是	String	配置模板对应的微服务框架
ConfigTemplateValue	否	是	String	配置模板数据
CreateTime	否	是	String	创建时间
UpdateTime	否	是	String	更新时间

ScalableSubRuleV2

弹性扩缩容监控指标类型

被如下接口引用：

名称	必选	允许NULL	类型	描述
Indicators	是	否	Uint64	监控指标，如监控CPU和MEM，则为百分比0-100；监控RT，则为响应时间(ms), 0-99999999
IndicatorType	是	否	Uint64	规则指标类型: 1:CPU, 2:MEM, 3:RT

UnitRule

微服务网关单元化规则

被如下接口引用：DescribeEnabledUnitRule、DescribeUnitRule、DescribeUnitRules

名称	必选	允许NULL	类型	描述
Id	否	是	String	规则ID
GatewayInstanceId	否	是	String	网关实体ID
Name	是	否	String	规则名称
Description	否	是	String	规则描述
Status	否	是	String	使用状态：enabled/disabled
UnitRuleItemList	否	是	Array of UnitRuleItem	规则项列表

ContainerGroupDeploy

获取部署组

被如下接口引用：DescribeContainerGroupDeployInfo

名称	必选	允许NULL	类型	描述
GroupId	是	是	String	部署组id
GroupName	是	是	String	分组名称
InstanceNum	是	是	Int64	实例总数
CurrentNum	是	是	Int64	已启动实例总数
Server	是	是	String	镜像server
Reponame	是	是	String	镜像名，如/tsf/nginx
TagName	是	是	String	镜像版本名称
CpuRequest	是	是	String	业务容器初始分配的 CPU 核数，对应 K8S request
CpuLimit	是	是	String	业务容器最大分配的 CPU 核数，对应 K8S limit
MemRequest	是	是	String	业务容器初始分配的内存 MiB 数，对应 K8S request
MemLimit	是	是	String	业务容器最大分配的内存 MiB 数，对应 K8S limit
AccessType	是	是	Int64	0:公网 1:集群内访问 2：NodePort
ProtocolPorts	是	是	Array of ProtocolPort	端口映射
UpdateType	是	是	Int64	更新方式：0:快速更新 1:滚动更新
UpdateIvl	是	是	Int64	更新间隔,单位秒
JvmOpts	是	是	String	jvm参数
SubnetId	是	是	String	子网id
AgentCpuRequest	是	是	String	agent容器初始分配的 CPU 核数，对应 K8S request
AgentCpuLimit	是	是	String	agent容器最大分配的 CPU 核数，对应 K8S limit
AgentMemRequest	是	是	String	agent容器初始分配的内存 MiB 数，对应 K8S request
AgentMemLimit	是	是	String	agent容器最大分配的内存 MiB 数，对应 K8S limit
IstioCpuRequest	是	是	String	istioproxy容器初始分配的 CPU 核数，对应 K8S request
IstioCpuLimit	是	是	String	istioproxy容器最大分配的 CPU 核数，对应 K8S limit
IstioMemRequest	是	是	String	istioproxy容器初始分配的内存 MiB 数，对应 K8S request
IstioMemLimit	是	是	String	istioproxy容器最大分配的内存 MiB 数，对应 K8S limit
Envs	是	是	Array of Env	部署组的环境变量数组，这里没有展示 tsf 使用的环境变量，只展示了用户设置的环境变量。
HealthCheckSettings	是	是	HealthCheckSettings	健康检查配置信息，若不指定该参数，则默认不设置健康检查。
DeployAgent	是	是	Bool	是否部署Agent容器

PathRewriteCreateObject

路径重写创建对象

被如下接口引用：CreatePathRewrites

名称	必选	允许NULL	类型	描述
GatewayGroupId	是	否	String	网关部署组ID
Regex	是	否	String	正则表达式
Replacement	是	否	String	替换的内容
Blocked	是	否	String	是否屏蔽映射后路径，Y: 是 N: 否
Order	是	否	Int64	规则顺序，越小优先级越高

DeleteImageTagV2

镜像版本

被如下接口引用：

名称	必选	允许NULL	类型	描述
Reponame	是	否	String	仓库名，如/tsf/nginx
TagName	是	否	Array of String	版本号:如V1

PolicyItem

tsf-privilege模块，策略项

被如下接口引用：CreatePolicyDocument

名称	必选	允许NULL	类型	描述
RoleId	是	是	String	角色ID
ProgramId	是	是	String	数据集ID

TsfRegionResult

地域信息

被如下接口引用：DescribeRegions

名称	必选	允许NULL	类型	描述
TRegionId	否	是	String	tRegionId
TRegionName	否	是	String	tRegionName
TRemark	否	是	String	tRemark

AdvanceSettings

高级选项设置

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

名称	必选	允许NULL	类型	描述
SubTaskConcurrency	否	否	Int64	子任务单机并发数限制，默认值为2

PagedProductNews

产品动态分组分页对象

被如下接口引用：DescribeProductNews

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总条数
Content	是	是	Array of ProductNews	产品动态列表

ImageTagsResult

镜像版本列表

被如下接口引用：DescribeImageTags

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	总记录数
RepoName	是	否	String	仓库名,含命名空间,如tsf/ngin
Server	是	否	String	镜像服务器地址
Content	是	否	Array of ImageTag	列表信息

ServerlessGroup

Serverless部署组信息

被如下接口引用：DescribeServerlessGroup、DescribeServerlessGroups

名称	必选	允许NULL	类型	描述
GroupId	是	是	String	部署组ID
GroupName	是	是	String	分组名称
CreateTime	是	是	String	创建时间
Status	是	是	String	服务状态
PkgId	是	是	String	程序包ID
PkgName	是	是	String	程序包名
ClusterId	是	是	String	集群id
ClusterName	是	是	String	集群名称
NamespaceId	是	是	String	命名空间id
NamespaceName	是	是	String	命名空间名称
VpcId	是	是	String	vpc ID
SubnetId	是	是	String	vpc 子网ID
PkgVersion	是	是	String	程序包版本
Memory	是	是	String	所需实例内存大小
InstanceRequest	是	是	Uint64	要求最小实例数
StartupParameters	是	是	String	部署组启动参数
ApplicationId	是	是	String	应用ID
InstanceCount	是	是	Uint64	部署组实例数
ApplicationName	是	是	Array of String	应用名称

AuthRule

微服务权限规则

被如下接口引用：DescribeAuthorization、DescribeAuthorizationType、DescribeAuthorizations

名称	必选	允许NULL	类型	描述
RuleId	是	否	String	规则ID
RuleName	是	否	String	规则名称
IsEnabled	是	否	String	是否启用
CreateTime	是	否	String	创建时间
UpdateTime	是	否	String	更新时间
MicroserviceId	是	否	String	微服务ID
Tags	是	否	Array of AuthConditionV2	标签列表

TsfPageMonitorGroup

列表中部署组分页信息，用于云监控

被如下接口引用：DescribeCloudMonitorGroups

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	部署组总数目
Content	是	是	Array of MonitorGroup	部署组列表信息

VmSubTaskV2

虚拟机子任务信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
InstanceId	是	是	String	机器Id
LanIp	是	是	String	内网IP
WanIp	是	是	String	外网IP
InstanceName	是	是	String	机器名称
AgentState	是	是	Int64	机器Agent状态
InstanceState	是	是	Int64	机器状态
TaskStatus	是	是	Int64	任务状态
TaskRecord	是	是	String	任务记录

TaskFlowEdge

工作流图中的边

被如下接口引用：CheckFlowGraphValidity、CreateTaskFlow、DescribeTaskFlowGraph、ModifyTaskFlow

名称	必选	允许NULL	类型	描述
NodeId	是	否	String	节点 ID
ChildNodeId	是	是	String	子节点 ID
CoreNode	是	是	String	是否核心任务,Y/N
EdgeType	是	是	String	边类型
NodeType	是	否	String	任务节点类型
PositionX	是	是	String	X轴坐标位置
PositionY	是	是	String	Y轴坐标位置
GraphId	是	是	String	图 ID
FlowId	是	是	String	工作流 ID
NodeName	是	是	String	节点名称
TaskId	是	是	String	任务ID
TaskLogId	是	是	String	任务历史ID

AlarmPolicyResult

被如下接口引用：DescribeAlarmPolicy、ListAlarmPolicies

名称	必选	允许NULL	类型	描述
PolicyId	否	是	String	PolicyId
PolicyName	否	是	String	PolicyName
EventPolicies	否	是	Array of EventPolicyResult	EventPolicies
EnabledEmail	否	是	Int64	EnabledEmail
EnabledSMS	否	是	Int64	EnabledSMS
Enabled	否	是	Int64	Enabled
Receivers	否	是	Array of AlarmReceiverResult	Receivers
AlarmSubId	否	是	Int64	AlarmSubId
UpdateTime	否	是	String	UpdateTime
CreateTime	否	是	String	CreateTime
EnabledWeChat	否	是	String	EnabledWeChat
EnabledRtx	否	是	String	EnabledRtx

ScalableTask

被如下接口引用：ListScalableTasks

名称	必选	允许NULL	类型	描述
Taskid	是	是	String	任务id
Desc	是	是	String	任务描述
CreateTime	是	是	String	CreateTime
EndTime	是	是	String	EndTime
TaskInstanceList	是	是	Array of TaskInstance	TaskInstanceList

TsfPageApplicationV2

应用分页信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	应用总数目
Content	是	是	Array of ApplicationForPage	应用信息列表

LicenseProduct

被如下接口引用：DescribeLicenseApplications

名称	必选	允许NULL	类型	描述
Name	是	否	String	产品名
Spec	否	是	String	产品规格
Function	否	是	Array of LicenseFunction	选配功能列表
Resource	否	是	Array of LicenseResource	受限资源列表

TsfPageFileConfig

文件配置项列表

被如下接口引用：DescribeFileConfigSummary、DescribeFileConfigs

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总数目
Content	是	是	Array of FileConfig	文件配置数组

OverviewGroupResourceUsage

部署组统计信息

被如下接口引用：DescribeClusterGroupCount、DescribeGroupResourceUsage

名称	必选	允许NULL	类型	描述
GroupCount	是	否	Uint64	部署组总数
RunGroupCount	是	否	Uint64	运行部署组总数
StopGroupCount	是	否	Uint64	停止中部署组总数
AbnormalGroupCount	是	否	Uint64	异常部署组总数

MeshLog

mesh 组件日志

被如下接口引用：SearchMeshLog、SearchOssRealtimeBusinessLog、SearchRealtimeBusinessLog、SearchRealtimeMeshLog、SearchRealtimeStdoutLog

名称	必选	允许NULL	类型	描述
InstanceId	是	是	String	实例ID
Content	是	是	String	日志内容
Timestamp	是	是	Uint64	日志时间戳
InstanceIp	是	是	String	实例IP
Type	是	是	Int64	mesh 组件类型（0：pilotagent，1：envoy，2：MeshDns）
GroupId	是	是	String	部署组ID

TaskExecuteRecord

任务执行信息

被如下接口引用：DescribeTaskExecuteRecords

名称	必选	允许NULL	类型	描述
BatchId	是	否	String	批次ID
ExecuteId	是	否	String	执行ID
State	是	否	String	状态
StartTime	是	是	Uint64	开始时间
EndTime	是	是	Uint64	结束时间
InstanceId	是	否	String	实例ID
RetryCount	是	是	Uint64	重试次数
GroupId	是	是	String	任务执行分组
TimeOut	是	是	Uint64	超时时间，单位ms
HistoryCount	是	是	Int64	执行历史数量
TriggerType	是	是	String	触发类型
ShardKey	是	是	Uint64	分片索引参数
ExecuteLogId	是	是	String	执行历史 ID
BatchLogId	是	是	String	批次历史 ID
TaskId	是	否	String	任务 ID
BatchType	是	是	String	批次类型
FailRetryTime	是	是	Int64	失败重试次数
ExecuteLog	是	是	String	执行日志
ExtraData	是	是	String	附加数据

ContainerGroupOther

部署组列表-其它字段

被如下接口引用：DescribeContainerGroupAttribute

名称	必选	允许NULL	类型	描述
InstanceNum	是	否	Int64	实例总数
CurrentNum	是	否	Int64	已启动实例总数
LbIp	是	否	String	负载均衡ip
ClusterIp	是	否	String	Service ip
Status	是	否	String	服务状态，请参考后面的的状态定义
Message	是	否	String	服务状态，请参考后面的的状态定义
Envs	是	否	Array of Env	环境变量
NodePort	是	是	Uint64	Service NodePort
SubnetId	是	是	String	子网ID
HealthCheckSettings	是	是	Array of HealthCheckSetting	健康检查相关字段
IsNotEqualServiceConfig	是	是	Bool	服务配置信息是否匹配

TsfPageApplicatoinServerLog

应用服务器的日志信息

被如下接口引用：DescribeApplicatoinServerLog

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	总条数
Content	是	否	Array of ApplicationServerLogContent	日志内容

RouteRule

路由规则信息

被如下接口引用：DescribeRouteReleaseHistory、DescribeRouteRule、DescribeRouteRules

名称	必选	允许NULL	类型	描述
RouteRuleId	是	是	String	路由规则Id
RouteRuleName	是	是	String	路由规则名称
RouteRuleType	是	是	String	路由规则类型，包括标签路由和权重标签，标签路由： T , 权重路由： W
RouteRuleDesc	是	是	String	路由规则描述信息
MicroserviceId	是	是	String	微服务Id
EnableStatus	是	是	Bool	true/false，true：路由规则为启用状态， false：路由规则为停用状态
CreateTime	是	是	String	路由规则创建时间
UpdateTime	是	是	String	路由规则更新时间
TagRouteItemList	是	是	Array of TagRouteItemList	标签路由规则项信息
WeightRouteItemList	是	是	Array of WeightRouteItemList	权重路由规则项信息
NamespaceId	是	是	String	微服务所属命名空间Id
MicroserviceName	是	是	String	微服务名称

DescribeTransactionsResp

查询主事务列表

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	返回的事务数量
Content	是	是	Array of TxMainTransaction	主事务信息

ScalableTaskV2

ScalableTask

被如下接口引用：

名称	必选	允许NULL	类型	描述
Taskid	是	是	String	任务id
Desc	是	是	String	任务描述
CreateTime	是	是	String	CreateTime
EndTime	是	是	String	EndTime
TaskInstanceList	是	是	Array of TaskInstance	TaskInstanceList

TaskRule

任务规则

被如下接口引用：CreateTask、CreateTaskFlow、DescribeTaskDetail、DescribeTaskFlow、DescribeTaskFlows、DescribeTaskRecords、ModifyTask、ModifyTaskFlow

名称	必选	允许NULL	类型	描述
RuleType	是	否	String	触发规则类型, Cron/Repeat
Expression	否	是	String	Cron类型规则，cron表达式。
RepeatInterval	否	是	Uint64	时间间隔，单位毫秒

MonitorStatisticsPolicyV2

MonitorStatisticsPolicy

被如下接口引用：

名称	必选	允许NULL	类型	描述
PolicyId	是	是	String	监控统计策略id
KeyWords	是	是	String	关键词
GroupList	是	是	Array of MonitorStatisticsPolicyGroup	部署组列表信息
NamespaceId	是	是	String	命名空间id
CreateTime	是	是	String	创建时间
UpdateTime	是	是	String	更新时间

MachineList

被如下接口引用：CreateMachines、DeleteMachines、ListMachines、ModifyMachines

名称	必选	允许NULL	类型	描述
MachineId	否	是	String	机器id
Ip	否	是	String	ip值
UserName	否	是	String	UserName值
Password	否	是	String	Password值
ModuleNames	否	是	Array of String	ModuleNames值
ZoneId	否	是	String	ZoneId值
ZoneName	否	是	String	ZoneName值
SshPort	否	是	Int64	SshPort值

TaskId

任务id

被如下接口引用：DeployGroup、DeployInstance、ExpandGroup、ShirkGroup、ShirkInstance、ShrinkGroup、ShrinkInstance、ShrinkInstances、StartGroup、StartInstance、StopGroup、StopInstance

名称	必选	允许NULL	类型	描述
TaskId	是	是	String	任务ID

LaneInfos

泳道分页查询

被如下接口引用：DescribeLanes

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总数
Content	是	是	Array of LaneInfo	泳道信息列表

ConfigTemplateResultV2

配置模板列表

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总数目
Content	是	是	Array of ConfigTemplate	配置模板列表

CircuitBreakerRule

熔断规则

被如下接口引用：DescribeCircuitBreakerRule、DescribeCircuitBreakerRules

名称	必选	允许NULL	类型	描述
RuleId	否	是	String	熔断规则主键
MicroserviceId	是	是	String	熔断规则微服务ID
MicroserviceName	是	是	String	微服务服务名称
NamespaceId	是	是	String	微服务所属命名空间id
TargetServiceName	是	是	String	目标服务名
TargetNamespaceId	是	是	String	目标服务所属命名空间ID
StrategyList	是	是	Array of CircuitBreakerStrategy	熔断策略
IsolationLevel	是	是	String	熔断级别
Enable	否	是	Bool	是否开启此规则
CreateTime	否	是	Int64	创建时间
UpdateTime	是	是	Int64	更新时间
AppId	否	是	String	APPID
Uin	否	是	String	Uin
SubAccountUin	否	是	String	subAccountUin
TargetNamespaceName	是	是	String	目标服务所属命名空间

ResultV2

FindMonitorObject返回的结果

被如下接口引用：

名称	必选	允许NULL	类型	描述
ObjName	是	否	String	KeyWordsName 和 GroupName

ScalableRule

被如下接口引用：ListScalableRule

名称	必选	允许NULL	类型	描述
RuleId	是	是	String	RuleId
Name	是	是	String	Name
ExpandVmCountLimit	是	是	Int64	ExpandVmCountLimit
ShrinkVmCountLimit	是	是	Int64	ShrinkVmCountLimit
GroupCount	是	是	Int64	GroupCount

TsfPageBusinessLog

业务日志列表

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总条数
Content	是	是	Array of BusinessLog	业务日志列表

TaskFlowBatch

工作流对象

被如下接口引用：DescribeFlowBatchHistoryRecords、DescribeFlowBatchRecord、DescribeFlowBatchRecords

名称	必选	允许NULL	类型	描述
FlowId	是	否	String	工作流 ID
FlowLogId	是	是	String	工作流历史 ID
FlowBatchLogId	是	否	String	工作流批次历史 ID
FlowBatchId	是	否	String	工作流批次 ID
State	是	是	String	状态
TriggerType	是	是	String	触发类型
ScheduleFireTime	是	是	Int64	预计触发时间
StartTime	是	是	Int64	开始执行时间
EndTime	是	是	Int64	结束执行时间
HistoryCount	是	是	Int64	批次历史数量
SpanTime	是	是	Int64	执行耗时
FlowName	是	是	String	工作流名称
TimeOut	是	是	Int64	超时时间

TsfPageVmTaskV2

虚拟机任务分页信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	任务总数目
Content	是	是	Array of VmTask	任务详情列表

PkgInfo

包信息

被如下接口引用：DescribePkgs、ListPkg

名称	必选	允许NULL	类型	描述
PkgId	是	是	String	程序包ID
PkgName	是	是	String	程序包名
PkgType	是	是	String	程序包类型
PkgVersion	是	是	String	程序包版本
PkgDesc	是	是	String	程序包描述
UploadTime	是	是	String	上传时间
Md5	是	是	String	程序包MD5
PkgPubStatus	是	是	Int64	程序包状态
PkgBindInfo	是	是	Array of PkgBind	程序包关联关系

TsfPageNamespace

Tsf命名空间分页对象

被如下接口引用：DescribeNamespaces、DescribeSimpleNamespaces

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	命名空间总条数
Content	是	是	Array of Namespace	命名空间列表

TsfPageBillingOperationRecord

BillingOperationRecord 翻页对象

被如下接口引用：DescribeBillingOperationRecords

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Uint64	记录总数
Content	是	是	Array of BillingOperationRecord	记录实体列表

GroupPodResultV2

部署组实例列表

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总记录数
Content	是	是	Array of GroupPod	列表信息

SidecarFilter

lua过滤器

被如下接口引用：DescribeSidecarFilter、DescribeSidecarFilters

名称	必选	允许NULL	类型	描述
FilterId	否	是	String	过滤器Id
FilterName	是	是	String	过滤器名称
ApplicationId	是	是	String	应用Id
ApplicationName	是	是	String	应用名称
Description	是	是	String	备注
WorkPosition	是	是	String	作用位置
TargetServiceNames	是	是	String	被调服务名
LuaValue	是	是	String	lua脚本值
Status	否	是	String	发布状态
CreateTime	否	是	String	创建时间
UpdateTime	否	是	String	更新时间
ReleasedTime	否	是	String	末次发布时间
AppId	否	是	String	APPID
Uin	否	是	String	Uin
SubAccountUin	否	是	String	subAccountUin
FilterGroupList	否	是	Array of SidecarFilterGroup	部署组列表

TemplateProjectV2

ProjectList

被如下接口引用：

名称	必选	允许NULL	类型	描述
ProjectId	是	是	String	工程id
ProjectName	是	是	String	工程名
BasePackage	是	是	String	包路径
LastTime	是	是	Int64	修改时间
Data	否	是	String	Data
AppId	否	是	String	AppId
Uin	否	是	String	Uin
SubAccountUin	否	是	String	SubAccountUin

TsfPageMeshLog

mesh 日志列表

被如下接口引用：SearchMeshLog、SearchOssRealtimeBusinessLog、SearchRealtimeBusinessLog、SearchRealtimeMeshLog、SearchRealtimeStdoutLog

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总条数
Content	是	是	Array of MeshLog	mesh日志列表
ScrollId	是	是	String	游标Id
Status	是	是	String	查询状态

ApplicationApiAccess

Serverless应用外网权限信息

被如下接口引用：DescribeApiAccess

名称	必选	允许NULL	类型	描述
Status	是	是	String	发布状态: SUCCEEDED/FAILED
SubDomain	是	是	String	系统给该服务自动分配的域名
ServiceId	是	是	String	ApiGateway 服务ID
Protocol	是	是	String	协议类型

ApiVersionArray

API版本数组

被如下接口引用：DescribeApiVersions

名称	必选	允许NULL	类型	描述
ApplicationId	是	是	String	App ID
ApplicationName	是	是	String	App 名称
PkgVersion	是	是	String	App 包版本

TaskLastExecuteStatus

任务最近一次执行状态

被如下接口引用：DescribeTaskLastStatus

名称	必选	允许NULL	类型	描述
BatchId	是	是	String	批次ID
State	是	是	String	运行状态，RUNNING/SUCCESS/FAIL/HALF/TERMINATED
BatchLogId	是	是	String	批次历史ID

ZipkinEndPoint

调用链Span端点信息

被如下接口引用：GetTraceSpans

名称	必选	允许NULL	类型	描述
ServiceName	是	是	String	端点服务名
Ipv4	是	是	String	端点IP地址（v4）
Ipv6	是	是	String	端点IP地址（v6）
Port	是	是	Int64	端点端口号

TsfPageVmGroup

列表中部署组分页信息

被如下接口引用：DescribeGroups

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	虚拟机部署组总数目
Content	是	是	Array of VmGroupSimple	虚拟机部署组列表信息

ResultStatus

APM模块任务下发成功/失败状态描述, 由于直接返回true或者false不足以前端做逻辑处理顾封装成Status对象,前端以状态码可做逻辑处理

被如下接口引用：CreateFlameGraph

名称	必选	允许NULL	类型	描述
Status	是	否	String	success任务下发成功/error任务下发失败
StatusInfo	是	否	String	success时为"",失败时为对应的错误信息
StatusCode	是	否	Int64	success时为0,失败时为对应错误码

ListMonitorStatisticsPolicyResult

ListMonitorStatisticsPolicy结果返回类型

被如下接口引用：

名称	必选	允许NULL	类型	描述
PolicyId	是	否	String	监控统计策略id
KeyWords	是	否	String	关键词
GroupList	是	否	GroupList	部署组列表信息
NamespaceId	是	否	String	命名空间id
CreateTime	是	否	String	创建时间
UpdateTime	是	否	String	更新时间

ClusterV3

集群详情

被如下接口引用：

名称	必选	允许NULL	类型	描述
ClusterId	是	是	String	集群ID
ClusterName	是	是	String	集群名称
ClusterDesc	是	是	String	集群描述
ClusterType	是	是	String	集群类型
VpcId	是	是	String	集群所属私有网络ID
ClusterStatus	是	是	String	集群状态
ClusterCIDR	是	是	String	集群CIDR
ClusterTotalCpu	是	是	Float	集群总CPU，单位: 核
ClusterTotalMem	是	是	Float	集群总内存，单位: G
ClusterUsedCpu	是	是	Float	集群已使用CPU，单位: 核
ClusterUsedMem	是	是	Float	集群已使用内存，单位: G
InstanceCount	是	是	Int64	集群机器实例数量
RunInstanceCount	是	是	Int64	集群运行中的机器实例数量
NormalInstanceCount	是	是	Int64	集群正常状态的机器实例数量
DeleteFlag	是	是	Bool	删除标记：true：可以删除；false：不可删除
CreateTime	是	是	String	创建时间
UpdateTime	是	是	String	更新时间
TsfRegionId	是	是	String	集群所属TSF地域ID
TsfRegionName	是	是	String	集群所属TSF地域名称
TsfZoneId	是	是	String	集群所属TSF可用区ID
TsfZoneName	是	是	String	集群所属TSF可用区名称

DtsTransaction

DTS主事务

被如下接口引用：

名称	必选	允许NULL	类型	描述
TxId	是	是	Int64	主事务ID
TxBegin	是	是	Int64	主事务开始时间戳，UTC，精确到毫秒
TxEnd	是	是	Int64	主事务结束时间戳，UTC，精确到毫秒
TxCommit	是	是	Int64	主事务提交时间戳，UTC，精确到毫秒
TxRollback	是	是	Int64	主事务回滚时间戳，UTC，精确到毫秒
TxError	是	是	Int64	主事务异常停止时间戳，UTC，精确到毫秒
Timeout	是	是	Int64	主事务超时时长，单位毫秒
Status	是	是	Int64	主事务状态
EndFlag	是	是	Int64	主事务结束标识
TimeoutFlag	是	是	Int64	主事务超时标识
Comment	是	是	String	异常信息
GroupId	是	是	String	事务分组ID
Server	是	是	String	主事务来源服务标识
BranchQty	是	是	Int64	分支事务数量
RetryFlag	是	是	Bool	重试标识：true：可以重试；false：不可重试

ThreadDetail

DescribeThreadDetail 接口出参封装

被如下接口引用：DescribeThreadDetail

名称	必选	允许NULL	类型	描述
ThreadName	是	否	String	线程名称
ThreadState	是	否	String	线程状态
ThreadInfos	是	否	String	线程堆栈信息

ImageRepository

镜像仓库

被如下接口引用：DescribeImageRepository

名称	必选	允许NULL	类型	描述
Reponame	是	是	String	仓库名,含命名空间,如tsf/nginx
Repotype	是	是	String	仓库类型
TagCount	是	是	Int64	镜像版本数
IsPublic	是	是	Int64	是否公共,1:公有,0:私有
IsUserFavor	是	是	Bool	是否被用户收藏。true：是，false：否
IsQcloudOfficial	是	是	Bool	是否是腾讯云官方仓库。是否是腾讯云官方仓库。true：是，false：否
FavorCount	是	是	Int64	被所有用户收藏次数
PullCount	是	是	Int64	拉取次数
Description	是	是	String	描述内容
CreationTime	是	是	String	创建时间
UpdateTime	是	是	String	更新时间

TsfPageMicroservice

微服务列表信息

被如下接口引用：DescribeMicroservices、DescribeMicroservicesByGroupIds、DescribeServiceNames

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	微服务总数目
Content	是	是	Array of Microservice	微服务列表信息

DockerForUseV2

Docker使用指引

被如下接口引用：

名称	必选	允许NULL	类型	描述
Server	是	否	String	仓库中心地址
Username	是	否	String	用户名

GetContainGroupOtherResultV2

部署组其他字段获取

被如下接口引用：

名称	必选	允许NULL	类型	描述
InstanceNum	是	否	Int64	实例总数
CurrentNum	是	否	Int64	已启动实例总数
LbIp	是	否	String	负载均衡ip
ClusterIp	是	否	String	Service ip
Status	是	否	String	服务状态，请参考后面的的状态定义
Message	是	否	String	异常信息,服务状态为Abnormal时才有

EnvsV2

环境变量

被如下接口引用：AnalyzeLogSchema、ValidateLogSchema

名称	必选	允许NULL	类型	描述
Name	是	否	String	环境变量名称
Value	是	否	String	服务端口

ImageRepositoryResultV2

镜像仓库列表

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总记录数
Server	是	是	String	镜像服务器地址
Content	是	是	Array of ImageRepository	列表信息

TsfPageBusinessLogV2

业务日志列表

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总条数
Content	是	是	Array of BusinessLogV2	业务日志列表
ScrollId	是	是	String	游标ID
Status	是	是	String	查询状态

ResourceBatchOperationStatusResult

描述批次操作的执行结果

被如下接口引用：ContinueResourceBatchOperation

名称	必选	允许NULL	类型	描述
OperationResult	是	否	Bool	批次操作的执行结果
BatchNum	是	否	Uint64	下一个需要执行操作的批次索引

ApplicationV2

应用

被如下接口引用：

名称	必选	允许NULL	类型	描述
ApplicationId	否	是	String	应用 ID，如 application-qv3dkda7
ApplicationName	否	是	String	应用名
ApplicationDesc	否	是	String	应用描述
ApplicationType	否	是	String	应用部署类型，V 表示 CVM 应用，C 表示容器应用
ApplicationJvmArg	否	是	String	应用启动时的 JVM 参数
MicroserviceType	否	是	String	应用类型，M 表示 Mesh 应用，N 表示 Spring Cloud 应用
ProgLang	否	是	String	应用编程语言，J 表示 Java，P 表示 Python
CreateTime	否	是	String	应用创建时间
UpdateTime	否	是	String	应用修改时间
InstanceCount	否	是	Int64	应用实例数
RunInstanceCount	否	是	Int64	应用当前运行实例数

RatelimitRuleV2

限流规则

被如下接口引用：CreateRatelimit、DescribeRatelimit

名称	必选	允许NULL	类型	描述
Id	否	否	String	规则ID
Name	是	否	String	规则名字，在一个微服务下唯一
Status	否	否	Uint64	状态 0表示启用 1表示停用
SourceService	否	否	String	限流规则区分的来源微服务名
DurationSecond	是	否	Uint64	限流周期，单位秒
DurationQuota	是	否	Uint64	每周期内的限流配额
ModifyTime	否	否	Uint64	最近一次修改规则时间，UTC秒数
Description	否	否	String	描述
Dimensions	否	是	Array of RatelimitDimension	限制条件列表

AuthConditionV2

用于 TSF 服务鉴权，表示鉴权条件

被如下接口引用：CreateAuthorization、DescribeAuthorization、DescribeAuthorizationType、DescribeAuthorizations、ModifyAuthorization

名称	必选	允许NULL	类型	描述
TagType	是	是	String	标签类型
TagField	是	是	String	标签名
TagOperator	是	是	String	标签运算符
TagValue	是	是	String	标签值
TagId	否	是	Int64	标签ID

MonitorStatisticsPolicyGroup

被如下接口引用：DescribeMonitorStatisticsPolicy、ListMonitorStatisticsPolicy

名称	必选	允许NULL	类型	描述
GroupId	是	是	String	GroupId
GroupName	是	是	String	GroupName
GroupDesc	是	是	String	GroupDesc
NamespaceId	是	是	String	NamespaceId
NamespaceName	是	是	String	NamespaceName
ApplicationId	是	是	String	ApplicationId
ApplicationName	是	是	String	ApplicationName
ClusterId	是	是	String	ClusterId
ClusterName	是	是	String	ClusterName

DtsAuth

分布式事务鉴权

被如下接口引用：

名称	必选	允许NULL	类型	描述
GroupId	是	否	String	事务分组ID
AppId	是	否	String	租户ID
Uin	是	否	String	主账号ID
SubAccountUin	是	否	String	子账号ID

TsfPageBusinessLogConfigV2

业务日志配置项列表

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总条数
Content	是	是	Array of BusinessLogConfig	业务日志配置项列表

InvocationStatisticsV2

服务调用统计

被如下接口引用：DescribeInvocationStatistics、DescribeInvocationStatisticsRatio

名称	必选	允许NULL	类型	描述
InvocationStatisticsName	是	是	String	调用统计名称
InvocationSumQuantity	是	是	Int64	请求总数
InvocationAvgDuration	是	是	Float	请求平均耗时，单位毫秒
Invocation2xxStatusQuantity	是	是	Int64	2xx状态码响应请求数
Invocation4xxStatusQuantity	是	是	Int64	4xx状态码响应请求数
Invocation5xxStatusQuantity	是	是	Int64	5xx状态码响应请求数
InvocationOtherStatusQuantity	是	是	Int64	其它状态码响应请求数
InvocationConnectFailedQuantity	是	是	Int64	连接失败请求数
InvocationTimeoutQuantity	是	是	Int64	超时请求数
InvocationUnavailableQuantity	是	是	Int64	服务不可用请求数
InvocationQuantityProportion	是	是	Float	请求数占比

VmTaskV2

虚拟机操作记录

被如下接口引用：

名称	必选	允许NULL	类型	描述
TaskId	是	是	String	任务Id
CreateTime	是	是	String	创建时间
TaskType	是	是	Int64	任务类型
GroupId	是	是	String	分组Id
GroupName	是	是	String	分组名称
PkgId	是	是	String	程序包Id
PkgName	是	是	String	程序包名称
PkgVersion	是	是	String	程序包版本
TaskDesc	是	是	String	任务描述
TotalCount	是	是	Int64	子任务数目
SuccessCount	是	是	Int64	成功的子任务数目
RunCount	是	是	Int64	运行中的子任务数目
FailCount	是	是	Int64	失败的子任务数目

ApiStatusResponse

API在线状态

被如下接口引用：DescribeApiStatus

名称	必选	允许NULL	类型	描述
Status	是	是	Int64	API 状态：0:离线，1:在线

LicenseDuration

被如下接口引用：DescribeLicenseApplications

名称	必选	允许NULL	类型	描述
ActiveTime	否	是	Uint64	开始时间，utc秒数
Period	否	是	Uint64	有效时长，单位秒

ZipkinSpanInfoV2

调用链Span信息

被如下接口引用：GetOssTraceSpans

名称	必选	允许NULL	类型	描述
Id	是	是	String	Span ID
TraceId	是	是	String	调用链ID
ParentId	是	是	String	父Span ID
Name	是	是	String	Span名称
Timestamp	是	是	Uint64	Span时间戳
Duration	是	是	Uint64	Span耗时
ResultStatus	是	是	String	Span结果
ServiceName	是	是	String	Span服务名（前端展示）
AnnotationList	是	是	Array of ZipkinAnnotationV2	Span注解列表
BinaryAnnotationList	是	是	Array of ZipkinBinaryAnnotationV2	Span二进制注解列表
MetadataList	是	是	Array of ZipkinMetadataV2	Span元数据列表
InterfaceName	是	是	String	Span接口名（前端展示）
LocalEndpoint	是	是	ZipkinEndpointV2	Span本地端点
RemoteEndpoint	是	是	ZipkinEndpointV2	Span远程端点
LabelList	是	是	Array of SpanLabel	Span标签列表

ServiceStatisticsResult

服务统计结果

被如下接口引用：DescribeStatistics

名称	必选	允许NULL	类型	描述
Path	是	是	String	请求模版路径:type为接口时返回，服务时不返回
Method	是	是	String	请求方法:type为接口时返回，服务时不返回
MicroserviceId	是	否	String	微服务Id
MicroserviceName	是	否	String	微服务名称
RequestCount	是	否	Uint64	请求数
ErrorRate	是	否	Float	请求错误率，不带百分号
AvgTimeConsuming	是	否	Float	平均响应耗时ms
MetricDataCurves	是	否	Array of MetricDataCurve	响应耗时曲线
InstanceId	是	是	String	实例id
InstanceName	是	是	String	实例name
GroupId	是	是	String	部署组id
GroupName	是	是	String	部署组name
ClusterType	是	是	String	部署组类型
GroupExist	是	是	Int64	部署组是否存在
InstanceExist	是	是	Int64	实例是否存在，仅限cvm

TaskInstanceV2

TaskInstance

被如下接口引用：

名称	必选	允许NULL	类型	描述
Id	是	是	String	id
Status	是	是	Int64	status
Mtime	是	是	String	mtime

TsfPageConfigReleaseLogV2

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

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总条数
Content	是	是	Array of ConfigReleaseLog	配置项发布日志数组

TsfPageRecordResourceTypeNameV2

操作记录资源类型分页列表

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总数目
Content	是	是	Array of RecordResourceTypeNameV2	资源类型列表

UnitNamespace

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

被如下接口引用：CreateUnitNamespaces、DescribeUnitNamespaces、DescribeUsableUnitNamespaces

名称	必选	允许NULL	类型	描述
Id	否	是	String	单元化命名空间ID
NamespaceId	是	否	String	命名空间ID
NamespaceName	是	否	String	命名空间Name

ClusterLimitResourceV2

集群limit资源

被如下接口引用：DescribeClusterLimitResource

名称	必选	允许NULL	类型	描述
CpuLimit	是	是	String	最大分配 CPU 核数
MemLimit	是	是	String	最大分配内存 MiB 数
CpuRequest	是	是	String	初始分配 CPU 核数
MemRequest	是	是	String	初始分配内存 MiB 数

TsfPageRouteReleaseHistory

路由规则启停记录分页对象

被如下接口引用：DescribeRouteReleaseHistory

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总数目
Content	是	是	Array of RouteReleaseHistory	路由规则部署记录列表信息

BusinesLogConfigAssociatedGroup

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

被如下接口引用：DescribeBusinessLogConfig、DescribeBusinessLogConfigs、DescribeGroupBusinessLogConfigs

名称	必选	允许NULL	类型	描述
GroupId	是	是	String	部署组ID
GroupName	是	是	String	部署组名称
ApplicationId	是	是	String	部署组所属应用ID
ApplicationName	是	是	String	部署组所属应用名称
ApplicationType	是	是	String	部署组所属应用类型
NamespaceId	是	是	String	部署组所属命名空间ID
NamespaceName	是	是	String	部署组所属命名空间名称
ClusterId	是	是	String	部署组所属集群ID
ClusterName	是	是	String	部署组所属集群名称
ClusterType	是	是	String	部署组所属集群类型
AssociatedTime	是	是	String	部署组关联日志配置时间

MonitorGroup

部署组信息，用于云监控

被如下接口引用：DescribeCloudMonitorGroups

名称	必选	允许NULL	类型	描述
GroupId	是	是	String	部署组ID
GroupName	是	是	String	部署组名称
ClusterId	是	是	String	集群ID
ClusterName	是	是	String	集群名称
ApplicationId	是	是	String	应用ID
ApplicationName	是	是	String	应用名称
NamespaceId	是	是	String	命名空间ID
NamespaceName	是	是	String	命名空间名称
GroupDesc	是	是	String	部署组描述信息

TsfPageGatewayPlugin

GatewayPlugin 翻页对象

被如下接口引用：DescribeGatewayPlugins、DescribePluginInstances

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Uint64	记录总数
Content	是	是	Array of GatewayPlugin	记录实体列表

ZipkinTraceInfoV2

调用链信息

被如下接口引用：SearchOssTrace、SearchTrace

名称	必选	允许NULL	类型	描述
TraceId	是	是	String	调用链ID
Timestamp	是	是	Uint64	调用链时间戳
Duration	是	是	Uint64	调用链时耗
ResultStatus	是	是	String	调用链结果
ResultError	是	是	Bool	调用链错误标识

CloudMonitorMicroserviceResult

被如下接口引用：DescribeMicroServiceList、ListCloudMicroServiceFindPagedList

名称	必选	允许NULL	类型	描述
TotalCount	否	否	Int64	TotalCount
Content	否	否	Array of CloudMonitorMicroservice	Content

ApiDetailInfo

API 明细

被如下接口引用：ChangeApiUsableStatus、DescribeApisWithPlugin、DescribeGatewayApis、DescribeUsableApis

名称	必选	允许NULL	类型	描述
ApiId	是	是	String	API ID
NamespaceId	是	是	String	命名空间ID
NamespaceName	是	是	String	命名空间名称
MicroserviceId	是	是	String	服务ID
MicroserviceName	是	是	String	服务名称
Path	是	是	String	API 请求路径
PathMapping	是	是	String	Api 映射路径
Method	是	是	String	请求方法
GroupId	是	是	String	所属分组ID
UsableStatus	是	是	String	是否禁用
ReleaseStatus	是	是	String	发布状态
RateLimitStatus	是	是	String	开启限流
MockStatus	是	是	String	是否开启mock
CreatedTime	是	是	String	创建时间
UpdatedTime	是	是	String	更新时间
ReleasedTime	是	是	String	发布时间
GroupName	是	是	String	所属分组名称
Timeout	是	是	Int64	API 超时，单位毫秒
Host	是	是	String	Api所在服务host
ApiType	是	是	String	API类型。 ms ：微服务API； external :外部服务Api
Description	是	是	String	Api描述信息
GatewayDeployGroupId	是	是	String	部署组ID

GatewayPluginDefinition

微服务网关插件定义数据

被如下接口引用：DescribeGatewayPluginTypes

名称	必选	允许NULL	类型	描述
Id	是	否	String	网关插件定义id
Name	是	是	String	插件名称
Description	是	是	String	插件描述
Type	是	是	String	插件类型
Tag	是	是	String	插件标签
CreatedTime	是	是	String	插件创建时间如:2019-06-20 15:51:28
UpdatedTime	是	是	String	插件更新时间如:2019-06-20 15:51:28
Order	是	是	Int64	插件排序

TsfPageGatewayDeployGroup

GatewayDeployGroup 翻页对象

被如下接口引用：DescribeGroupBindedGateways、DescribeUsableGatewayGroups

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	记录总数
Content	是	否	Array of GatewayDeployGroup	记录实体列表

AuthRuleGroup

微服务权限规则组

被如下接口引用：DescribeAuthorizationType

名称	必选	允许NULL	类型	描述
Rules	是	是	Array of AuthRule	规则列表
RuleProgram	是	是	String	规则列表计算逻辑
Type	是	是	String	权限类型，D：未启用；B：黑名单模式；W：白名单模式
MicroserviceId	是	是	String	微服务ID

TaskFlowBatchHistory

查询工作流执行批次的历史

被如下接口引用：

名称	必选	允许NULL	类型	描述
FlowId	是	否	String	工作流 ID
FlowLogId	是	是	String	工作流历史 ID
FlowBatchLogId	是	是	String	工作流批次历史 ID
FlowBatchId	是	是	String	工作流批次 ID
StartTime	是	是	Uint64	开始时间
EndTime	是	是	Uint64	结束时间
SpanTime	是	是	Int64	耗时
HistoryCount	是	否	Int64	历史数
State	是	是	String	状态
TriggerType	是	是	String	触发类型
ScheduleFireTime	是	是	Int64	下次开始时间
FlowName	是	是	String	工作流名称

GroupApiUseStatistics

API监控明细数据

被如下接口引用：DescribeApiUseDetail

名称	必选	允许NULL	类型	描述
TopStatusCode	是	是	Array of ApiUseStatisticsEntity	总调用数
TopTimeCost	是	是	Array of ApiUseStatisticsEntity	平均错误率
Quantile	是	是	QuantileEntity	分位值对象

SimpleGroupV2

部署组

被如下接口引用：

名称	必选	允许NULL	类型	描述
GroupId	是	是	String	部署组ID
GroupName	是	是	String	部署组名称
ApplicationId	是	是	String	应用ID
ApplicationName	是	是	String	应用名称
ApplicationType	是	是	String	应用类型
ClusterId	是	是	String	集群ID
ClusterName	是	是	String	集群名称
ClusterType	是	是	String	集群类型
NamespaceId	是	是	String	命名空间ID
NamespaceName	是	是	String	命名空间名称

TsfPageLicenseTag

LicenseTag 翻页对象

被如下接口引用：DescribeLicenses

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Uint64	记录总数
Content	是	是	Array of LicenseTag	记录实体列表

InvocationStatisticsRatio

服务调用监控指标数据比例

被如下接口引用：DescribeInvocationStatisticsRatio

名称	必选	允许NULL	类型	描述
InvocationCurrentStatistics	是	是	InvocationStatisticsV2	当前统计数据
InvocationTargetStatistics	是	是	InvocationStatisticsV2	目标统计数据
InvocationSumQuantityRatio	是	是	Float	请求总数对比
InvocationAvgDurationRatio	是	是	Float	请求平均耗时对比
Invocation2xxStatusQuantityRatio	是	是	Float	2xx状态码响应请求数对比
Invocation4xxStatusQuantityRatio	是	是	Float	4xx状态码响应请求数对比
Invocation5xxStatusQuantityRatio	是	是	Float	5xx状态码响应请求数对比
InvocationOtherStatusQuantityRatio	是	是	Float	其它状态码响应请求数对比
InvocationConnectFailedQuantityRatio	是	是	Float	连接失败请求数对比
InvocationTimeoutQuantityRatio	是	是	Float	超时请求数对比
InvocationUnavailableQuantityRatio	是	是	Float	服务不可用请求数对比

PagedResource

分页资源列表

被如下接口引用：DescribeResources

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	总条数
Content	是	否	Array of Resource	资源列表

TraceSpanInfo

span查询的出参

被如下接口引用：SearchSpan

名称	必选	允许NULL	类型	描述
TraceId	否	否	String	调用链traceid
SpanId	否	否	String	调用链spanid
ParentId	否	否	String	调用链parentid
Kind	否	否	String	调用链类型
Name	否	否	String	调用链name
Timestamp	否	否	Uint64	时间戳
Duration	否	否	Float	耗时
ResultStatus	否	否	String	状态
LocalComponent	否	否	String	组件
LocalEndpoint	否	否	ZipkinEndpointV2	local端点信息
RemoteEndpoint	否	否	ZipkinEndpointV2	remote端点信息
TagList	否	否	Array of SpanLabel	tags列表
GroupId	否	否	String	部署组id
GroupName	否	否	String	部署组名称
ClusterType	否	否	String	集群类型
NamespaceId	否	否	String	命名空间id
NamespaceName	否	否	String	命名空间名称
ResultCode	否	否	String	状态码
ServiceName	否	否	String	服务名
ServiceId	否	否	String	服务id

TsfPageFileConfigRelease

文件配置项发布信息列表

被如下接口引用：DescribeFileConfigReleases

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	数量
Content	是	是	Array of FileConfigRelease	列表

ServiceConfig

服务配置

被如下接口引用：CreateApplication、DescribeApplication、DescribeApplications、ModifyApplication

名称	必选	允许NULL	类型	描述
Name	是	否	String	服务名
Ports	是	否	Array of Ports	端口信息列表
HealthCheck	否	是	HealthCheckConfig	健康检查配置

FileConfigReleaseLog

文件配置项发布日志

被如下接口引用：DescribeFileConfigReleaseLogs

名称	必选	允许NULL	类型	描述
ConfigReleaseLogId	是	是	String	配置项发布日志ID
ConfigId	是	是	String	配置项ID
ConfigName	是	是	String	配置项名称
ConfigVersion	是	是	String	配置项版本
LastConfigId	是	是	String	上次配置项ID
LastConfigName	是	是	String	上次配置项名称
LastConfigVersion	是	是	String	上次配置项版本
ReleaseDesc	是	是	String	发布描述
ReleaseStatus	是	是	String	发布状态
ReleaseTime	是	是	String	发布时间
RollbackFlag	是	是	Bool	回滚标识
GroupId	是	是	String	部署组ID
GroupName	是	是	String	部署组名称
NamespaceId	是	是	String	命名空间ID
NamespaceName	是	是	String	命名空间名称
ClusterId	是	是	String	集群ID
ClusterName	是	是	String	集群名称

ResourceTaskStatusResult

资源任务转态结果

被如下接口引用：DescribeResourceTaskStatus

名称	必选	允许NULL	类型	描述
TaskStatus	是	是	Uint64	任务的执行状态

TaskFlowPage

工作流分页对象

被如下接口引用：DescribeTaskFlows

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	工作流总数
Content	是	否	Array of TaskFlow	工作流分页对象

TsfPageTraceInterface

调用链接口列表

被如下接口引用：GetOssTraceInterfaces、GetTraceInterfaces

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	符合条件的总调用链接口数量
Content	是	是	Array of String	调用链接口列表

MsRunningApplicationV2

微服务应用信息

被如下接口引用：DescribeMsRunningApplications

名称	必选	允许NULL	类型	描述
ApplicationId	是	否	String	应用ID
ApplicationName	是	是	String	应用名称

BusinessLogConfigV2

业务日志配置

被如下接口引用：

名称	必选	允许NULL	类型	描述
ConfigId	否	否	String	配置项ID
ConfigName	否	否	String	配置项名称
ConfigPath	否	是	String	配置项日志路径
ConfigDesc	否	是	String	配置项描述
ConfigTags	否	是	String	配置项标签
ConfigPipeline	否	是	String	配置项对应的ES管道
ConfigCreateTime	否	是	String	配置项创建时间
ConfigUpdateTime	否	是	String	配置项更新时间
ConfigSchema	否	是	BusinessLogConfigSchema	配置项解析规则
ConfigAssociatedGroups	否	是	Array of BusinesLogConfigAssociatedGroup	配置项关联部署组

MicroserviceWrong

微服务

被如下接口引用：

名称	必选	允许NULL	类型	描述
MicroserviceId	否	是	String	微服务Id
MicroserviceName	否	是	String	名称
MicroserviceDesc	否	是	String	描述
MicroserviceType	否	是	String	类型
AssociateApplicationId	否	是	String	关联的应用 ID
MicroserviceProtocol	否	是	String	协议
MicroserviceListeningPort	否	是	Int64	监听端口
HealthCheckUrl	否	是	String	健康检查参数
ServiceClustertype	否	是	String	集群类型
CreateTime	否	是	Int64	创建时间
UpdateTime	否	是	Int64	更新时间
NamespaceId	否	是	String	命名空间Id
RunInstanceCount	否	是	Int64	微服务的运行实例数目
AssociateApplication	否	是	MsApplication	关联的应用详情

ResourceNodeStatus

模块节点的资源使用情况

被如下接口引用：DescribeResourceUsageRate

名称	必选	允许NULL	类型	描述
Used	是	否	Uint64	已使用的资源量
Total	是	否	Uint64	总的资源量

DescribeTemplateResult

被如下接口引用：

名称	必选	允许NULL	类型	描述
ProjectId	是	否	String	ProjectId
ProjectName	是	否	String	ProjectName
BasePackage	是	否	String	BasePackage
PomGroupId	是	否	String	PomGroupId
PomArtifactId	是	否	String	PomArtifactId
PomVersion	是	否	String	PomVersion
PomName	是	否	String	PomName
PomDesc	是	否	String	PomDesc
GetMethod	是	否	String	GetMethod
Ms	是	否	Array of Ms	Ms
Action	否	否	String	action
AppId	否	否	String	appId
Uin	否	否	String	Uin
SubAccountUin	否	否	String	SubAccountUin

ThreadDetailInfo

线程数据详情

被如下接口引用：DescribeThreadDetailList

名称	必选	允许NULL	类型	描述
ThreadName	是	否	String	线程名
ThreadState	是	否	String	线程状态
ThreadInfos	是	否	String	线程堆栈信息
ThreadCpuUtil	是	是	Float	CPU利用率
ThreadAllocatedBytes	是	是	Int64	堆内存大小
ThreadCpuTime	是	是	Int64	CPU 运行时间
ThreadBlockCount	是	是	Int64	线程阻塞个数

ServiceStatisticsV2

服务运行统计指标

被如下接口引用：DescribeServiceStatistics

名称	必选	允许NULL	类型	描述
ServiceId	是	是	String	服务ID
ReqTotalQty	是	是	Uint64	总请求量
ReqSuccessRate	是	是	Float	请求成功率
ReqAvgDuration	是	是	Float	请求平均耗时

MasterApiResult

透传masterApi的response回前端

被如下接口引用：

名称	必选	允许NULL	类型	描述
Data	否	是	String	Data
ErrMsg	否	是	String	ErrMsg

ConfigV2

配置项

被如下接口引用：

名称	必选	允许NULL	类型	描述
ConfigId	是	是	String	配置项ID
ConfigName	是	是	String	配置项名称
ConfigVersion	是	是	String	配置项版本
ConfigVersionDesc	是	是	String	配置项版本描述
ConfigValue	是	是	String	配置项值
ConfigType	是	是	String	配置项类型
CreationTime	是	是	String	创建时间
ApplicationId	是	是	String	应用ID
ApplicationName	是	是	String	应用名称
DeleteFlag	是	是	Bool	删除标识，true：可以删除；false：不可删除
LastUpdateTime	是	是	String	最后更新时间
ConfigVersionCount	是	是	Int64	配置项版本数量

GatewayQQMiniProgramLoginPlugin

微服务网关qq登录插件

被如下接口引用：DescribeGatewayQQMiniProgramLoginPlugin

名称	必选	允许NULL	类型	描述
Id	是	否	String	网关插件ID
Name	是	否	String	插件名称
Description	是	是	String	插件描述
Type	是	否	String	插件类型
CreatedTime	是	否	String	插件创建时间如:2019-06-20 15:51:28
UpdatedTime	是	否	String	插件更新时间如:2019-06-20 15:51:28
Status	是	否	String	发布状态: drafted/released
QqAppId	是	否	String	QQ小程序AppId
RequestCodeBaggagePosition	是	否	String	QQ小程序请求code携带位置：header/cookie
SessionKeyName	是	否	String	自定义登录态参数名
SessionExpireTime	是	否	Int64	自定义登录态过期时间，单位：秒
RequestSessionBaggagePosition	是	否	String	前台业务请求自定义登录态参数位置：header/cookie
BusinessSessionBaggagePosition	是	否	String	向业务后台传输登录态参数位置：header/query/cookie
ResponseSessionBaggagePosition	是	否	String	返回自定义登录态参数位置：header
MetaDataTagInfoList	是	是	String	元数据转标签配置的Json串
CustomizeTagInfoList	是	是	String	自定义标签配置的Json串

PkgInfoV2

包信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
PkgId	是	是	String	无
PkgName	是	是	String	无
PkgType	是	是	String	无
PkgVersion	是	是	String	无
PkgDesc	是	是	String	无
UploadTime	是	是	String	无
Md5	是	是	String	无
PkgPubStatus	是	是	Int64	无

TaskFlowLastBatchState

工作流最近批次的状态

被如下接口引用：DescribeFlowLastBatchState

名称	必选	允许NULL	类型	描述
FlowBatchId	是	是	String	批次ID
FlowBatchLogId	是	是	String	批次历史ID
State	是	是	String	状态,WAITING/SUCCESS/FAILED/RUNNING/TERMINATING

RepositoryList

仓库列表

被如下接口引用：DescribeRepositories

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	仓库总量
Content	是	是	Array of RepositoryInfo	仓库信息列表

OverviewMsResultV2

概览页微服务信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
RunMicroserviceCount	是	是	Int64	概览页微服务数目

Person

tsf告警策略的接收者

被如下接口引用：CreateAlarmPolicy

名称	必选	允许NULL	类型	描述
CellPhoneNumber	是	否	String	接收成员电话
Email	是	否	String	接收成员email
Name	是	否	String	接收成员的名字

PermCat

tsf-privilege 模块 PermissionCategory 权限组

被如下接口引用：DescribePermissionCategories、DescribeRole、DescribeRoles

名称	必选	允许NULL	类型	描述
PermCatId	否	是	String	权限组ID
PermCatName	否	是	String	权限组名称
ResourceId	否	是	String	资源ID
ResourceName	否	是	String	资源名称
CreationTime	否	是	Int64	创建时间
LastUpdateTime	否	是	Int64	最后更新时间
DeleteFlag	否	是	Bool	删除标识
ServiceCode	否	是	String	产品编码
ServiceName	否	是	String	产品名称
PermCatDesc	否	是	String	权限组描述

InvocationStatistics

调用统计数据

被如下接口引用：

名称	必选	允许NULL	类型	描述
ReqSuccessStats	是	是	Array of StatisticsCoord	请求健康概览统计成功请求数
ReqFailedStats	是	是	Array of StatisticsCoord	请求健康概览统计失败请求数
ReqStatusStats	是	是	Array of StatisticsCoord	请求健康概览统计状态码分布
ReqDurationStats	是	是	Array of StatisticsCoord	请求时延概览统计时延分布
ReqQuantityStats	是	是	Array of StatisticsCoord	请求并发概览统计并发请求次数

TsfJvmLogPage

Jvm日志查询返回数据封装

被如下接口引用：DescribeJvmLogs

名称	必选	允许NULL	类型	描述
Content	是	是	Array of JvmLog	jvm日志详情列表
TotalCount	是	是	Int64	总数目
ScrollId	是	是	String	游标ID, 根据游标Id查询后续结果

BusinessLogConfigSchemaV2

业务日志配置解析规则

被如下接口引用：

名称	必选	允许NULL	类型	描述
SchemaType	是	否	Int64	解析规则类型
SchemaContent	否	是	String	解析规则内容
SchemaDateFormat	否	是	String	解析规则时间格式
SchemaMultilinePattern	否	是	String	解析规则对应的多行匹配规则
SchemaCreateTime	否	是	String	解析规则创建时间
SchemaPatternLayout	否	是	String	解析规则内容，包含解析规则时间格式和解析规则内容
SchemaLogMessage	否	是	String	模拟解析的日志内容

Application

应用

被如下接口引用：

名称	必选	允许NULL	类型	描述
ApplicationId	否	是	String	应用 ID，如 application-qv3dkda7
ApplicationName	否	是	String	应用名
ApplicationDesc	否	是	String	应用描述
ApplicationType	否	是	String	应用部署类型，V 表示 CVM 应用，C 表示容器应用
ApplicationJvmArg	否	是	String	应用启动时的 JVM 参数
MicroserviceType	否	是	String	应用类型，M 表示 Mesh 应用，N 表示 Spring Cloud 应用
ProgLang	否	是	String	应用编程语言，J 表示 Java，P 表示 Python
CreateTime	否	是	String	应用创建时间
UpdateTime	否	是	String	应用修改时间
InstanceCount	否	是	Int64	应用实例数
RunInstanceCount	否	是	Int64	应用当前运行实例数

DumpResultV2

DumpResult

被如下接口引用：

名称	必选	允许NULL	类型	描述
Name	否	是	String	Name
State	否	是	String	State
Detail	否	是	String	Detail

ServiceSetting

容器网络设置。

被如下接口引用：DeployContainerGroup

名称	必选	允许NULL	类型	描述
AccessType	是	是	Int64	0:公网, 1:集群内访问, 2：NodePort, 3: VPC 内网访问
ProtocolPorts	是	是	Array of ProtocolPort	容器端口映射
SubnetId	是	是	String	子网ID

TxErrorV2

事务查询异常信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
Code	是	是	String	错误码
Message	是	是	String	错误信息

ContainerGroupDetail

容器部署组详情

被如下接口引用：DescribeContainerGroupDetail

名称	必选	允许NULL	类型	描述
GroupId	是	是	String	部署组ID
GroupName	是	是	String	分组名称
InstanceNum	是	是	Int64	实例总数
CurrentNum	是	是	Int64	已启动实例总数
CreateTime	是	是	String	创建时间
Server	是	是	String	镜像server
Reponame	是	是	String	镜像名，如/tsf/nginx
TagName	是	是	String	镜像版本名称
ClusterId	是	是	String	集群ID
ClusterName	是	是	String	集群名称
NamespaceId	是	是	String	命名空间ID
NamespaceName	是	是	String	命名空间名称
ApplicationId	是	是	String	应用ID
LbIp	是	是	String	负载均衡ip
ApplicationType	是	是	String	应用类型
ClusterIp	是	是	String	Service ip
NodePort	是	是	Int64	NodePort端口，只有公网和NodePort访问方式才有值
CpuLimit	是	是	String	最大分配的 CPU 核数，对应 K8S limit
MemLimit	是	是	String	最大分配的内存 MiB 数，对应 K8S limit
AccessType	是	是	Uint64	0:公网 1:集群内访问 2：NodePort
UpdateType	是	是	Int64	更新方式：0:快速更新 1:滚动更新
UpdateIvl	是	是	Int64	更新间隔,单位秒
ProtocolPorts	是	是	Array of ProtocolPort	端口数组对象
Envs	是	是	Array of Env	环境变量数组对象
ApplicationName	是	是	String	应用名称
Message	是	是	String	pod错误信息描述
Status	是	是	String	部署组状态
MicroserviceType	是	是	String	服务类型
CpuRequest	是	是	String	初始分配的 CPU 核数，对应 K8S request
MemRequest	是	是	String	初始分配的内存 MiB 数，对应 K8S request
SubnetId	是	是	String	子网id
GroupResourceType	是	是	String	部署组资源类型
InstanceCount	是	是	Uint64	部署组实例个数
UpdatedTime	是	是	Int64	部署组更新时间戳
MaxSurge	是	是	String	kubernetes滚动更新策略的MaxSurge参数
MaxUnavailable	是	是	String	kubernetes滚动更新策略的MaxUnavailable参数
HealthCheckSettings	是	是	HealthCheckSettings	部署组健康检查设置

DescribeSingleContainerGroupsV2

部署组-独立菜单

被如下接口引用：

名称	必选	允许NULL	类型	描述
GroupId	否	是	String	groupId
GroupName	否	是	String	分组名称
CpuLimit	否	是	String	最大分配的 CPU 核数，对应 K8S limit
Server	是	是	String	镜像server
Reponame	是	是	String	镜像名，如/tsf/nginx
TagName	是	是	String	镜像版本名称
ClusterId	是	是	String	集群id
ClusterName	是	是	String	集群名称
NamespaceId	是	是	String	命名空间id
NamespaceName	是	是	String	命名空间名称
ApplicationId	是	是	String	应用名称
ApplicationName	是	是	String	应用类型
ApplicationType	是	是	String	分组创建时间
MemLimit	是	是	String	最大分配的内存 MiB 数，对应 K8S limit
MicroserviceType	是	是	String	微服务类型
ProtocolPorts	是	是	Array of ProtocolPort	端口列表
UpdateType	是	是	Int64	更新类型
UpdateIvl	是	是	Int64	更新时间间隔
AccessType	是	是	Int64	网络访问类型
CreateTime	是	是	String	创建时间
CpuRequest	是	是	String	初始分配的 CPU 核数，对应 K8S request
MemRequest	是	是	String	初始分配的内存 MiB 数，对应 K8S request
SubnetId	是	是	String	子网id

TemplateResultV2

TemplateResult

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	TotalCount
Content	是	是	Array of TemplateProject	Content

OverviewClusterResourceUsage

集群概览页信息

被如下接口引用：DescribeClusterUsage

名称	必选	允许NULL	类型	描述
ClusterId	是	否	String	集群ID
ClusterName	是	否	String	集群名
ClusterTotalCpu	是	否	Float	集群总 CPU
ClusterUsedCpu	是	否	Float	集群已使用 CPU
ClusterTotalMem	是	否	Float	集群总内存
ClusterUsedMem	是	否	Float	集群已使用内存

ZipkinBinaryAnnotationV2

调用链Span二进制注解

被如下接口引用：GetOssTraceSpans

名称	必选	允许NULL	类型	描述
Key	是	是	String	注解键
Value	是	是	String	注解值
Endpoint	是	是	ZipkinEndpointV2	注解端点信息

TsfPageUnitRule

单元化规则翻页对象

被如下接口引用：DescribeUnitRules

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	记录总数
Content	是	否	Array of UnitRule	记录实体列表

VpcConfig

vpc 配置信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
VpcId	是	否	String	VpcId
SubnetId	是	否	String	SubnetId 子网ID

PagedDtsBranch

DTS分支事务分页对象

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	总条数
Content	是	是	Array of DtsBranch	分支事务分组列表

TsfPageNamespaceWrong

Tsf命名空间分页对象

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总条数
Content	是	是	Array of NamespaceWrong	命名空间列表

VolumeItem

容器卷挂载项信息

被如下接口引用：DescribeContainerVolumeOptions

名称	必选	允许NULL	类型	描述
Name	否	否	String	数据卷名称

RouteDestV2

服务路由目标规则

被如下接口引用：CreateRoute、DescribeRoute、DescribeRoutes、ModifyRoute

名称	必选	允许NULL	类型	描述
DestId	否	是	String	路由规则项路由目标ID
DestWeight	是	否	Int64	路由目标权重
DestItemList	是	是	Array of RouteDestItemV2	路由目标匹配条件列表
RouteRuleId	否	是	String	服务路由目标所属路由规则项ID

ServiceStatistics

服务运行统计指标

被如下接口引用：GetServiceStatistics

名称	必选	允许NULL	类型	描述
ServiceId	是	是	String	服务ID
RequestAmount	是	是	String	总请求量
SuccessAmount	是	是	String	请求成功量
SuccessRate	是	是	String	请求成功率
MaxDuration	是	是	String	请求最大耗时
MinDuration	是	是	String	请求最小耗时
AvgDuration	是	是	String	请求平均耗时

MonitorStatisticsPolicyResult

被如下接口引用：ListMonitorStatisticsPolicy

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	TotalCount
Content	是	是	Array of MonitorStatisticsPolicy	Content

DeliveryConfigBindGroup

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

被如下接口引用：DescribeAssociateRelation、DescribeDeliveryConfigs

名称	必选	允许NULL	类型	描述
ConfigId	是	否	String	配置id
ConfigName	是	否	String	配置名
CollectPath	是	是	Array of String	采集路径
Groups	是	是	Array of GroupInfo	关联部署组信息
CreateTime	是	是	String	创建时间

DescribeResourceConfigSts

DescribeResourceConfig

被如下接口引用：DescribeResourceConfig

名称	必选	允许NULL	类型	描述
Uin	是	是	String	uin

RepositoryError

仓库相关错误

被如下接口引用：

名称	必选	允许NULL	类型	描述
Code	是	是	String	无
Message	是	是	String	无

TaskRecordPage

翻页查询的任务记录返回

被如下接口引用：DescribeTaskRecords

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	总数量
Content	是	否	Array of TaskRecord	任务记录列表

PagedDtsGroup

事务分组分页对象

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总条数
Content	是	是	Array of DtsGroup	事务分组列表

PkgListV2

包列表

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	包总量
Content	是	是	Array of PkgInfo	报信息列表

TsfPageImageFeature

镜像特征列表

被如下接口引用：DescribeImageFeatures

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	镜像特征总数目
Content	是	是	Array of ImageFeature	镜像特征列表

ZipkinAnnotationV2

调用链Span注解

被如下接口引用：GetOssTraceSpans

名称	必选	允许NULL	类型	描述
Value	是	是	String	注解值
Timestamp	是	是	Uint64	注解时间戳
Endpoint	是	是	ZipkinEndpointV2	注解端点信息

TsfRegion

TSF地域

被如下接口引用：DescribeTsfRegions

名称	必选	允许NULL	类型	描述
Id	是	是	String	TSF地域ID
Name	是	是	String	TSF地域名称

MonitorStatisticsPolicyResultV2

MonitorStatisticsPolicyResult

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	TotalCount
Content	是	是	Array of MonitorStatisticsPolicy	Content

Instance

机器实例

被如下接口引用：DescribeAddibleInstances、DescribeClusterInstances、DescribeGroupAddibleInstances、DescribeGroupInstances、DescribeSimpleInstances

名称	必选	允许NULL	类型	描述
InstanceId	是	是	String	机器实例ID
InstanceName	是	是	String	机器名称
LanIp	是	是	String	机器内网地址IP
WanIp	是	是	String	机器外网地址IP
InstanceDesc	是	是	String	机器描述信息
ClusterId	是	是	String	集群ID
ClusterName	是	是	String	集群名称
InstanceStatus	是	是	String	VM的状态虚机：虚机的状态容器：Pod所在虚机的状态
InstanceAvailableStatus	是	是	String	VM的可使用状态虚机：虚机是否能够作为资源使用容器：虚机是否能够作为资源部署POD
ServiceInstanceStatus	是	是	String	服务下的服务实例的状态虚机：应用是否可用 + Agent状态容器：Pod状态
CountInTsf	是	是	Int64	标识此instance是否已添加在tsf中
GroupId	是	是	String	机器所属部署组ID
ApplicationId	是	是	String	机器所属应用ID
ApplicationName	是	是	String	机器所属应用名称
InstanceCreatedTime	是	是	String	机器实例在CVM的创建时间
InstanceExpiredTime	是	是	String	机器实例在CVM的过期时间
InstanceChargeType	是	是	String	机器实例在CVM的计费模式
InstanceTotalCpu	是	是	Float	机器实例总CPU信息
InstanceTotalMem	是	是	Float	机器实例总内存信息
InstanceUsedCpu	是	是	Float	机器实例使用的CPU信息
InstanceUsedMem	是	是	Float	机器实例使用的内存信息
InstanceLimitCpu	是	是	Float	机器实例Limit CPU信息
InstanceLimitMem	是	是	Float	机器实例Limit 内存信息
InstancePkgVersion	是	是	String	包版本
ClusterType	是	是	String	集群类型
RestrictState	是	是	String	机器实例业务状态
UpdateTime	是	是	String	更新时间
OperationState	是	是	Int64	实例执行状态
NamespaceId	是	是	String	NamespaceId Ns ID
InstanceZoneId	是	是	String	InstanceZoneId 可用区ID
InstanceImportMode	是	是	String	InstanceImportMode 导入模式
ApplicationType	是	是	String	ApplicationType应用类型
ApplicationResourceType	是	是	String	ApplicationResourceType 资源类型
ServiceSidecarStatus	是	是	String	sidecar状态
GroupName	是	是	String	部署组名
NamespaceName	是	是	String	NS名
Reason	是	是	String	健康检查原因
AgentVersion	是	是	String	agent版本
InstanceCpuType	否	是	String	实例cpu架构

MonitorOverview

监控概览对象

被如下接口引用：DescribeGatewayMonitorOverview

名称	必选	允许NULL	类型	描述
InvocationCountOfDay	是	是	String	近24小时调用数量
InvocationCount	是	是	String	总调用数量
ErrorCountOfDay	是	是	String	近24小时调用错误数量
ErrorCount	是	是	String	总调用错误数量
SuccessRatioOfDay	是	是	String	近24小时调用成功率
SuccessRatio	是	是	String	总调用成功率

TsfPageSimpleApplication

TSF分页简单应用对象

被如下接口引用：DescribeSimpleApplications

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总条数
Content	是	是	Array of SimpleApplication	简单应用列表

WeightRouteItemV2

权重路由规则项

被如下接口引用：

名称	必选	允许NULL	类型	描述
WeightRouteId	否	否	String	权重路由规则项ID
SourcePercent	是	否	Int64	权重路由，百分比数值
TargetField	是	否	String	权重路由规则匹配目标字段
TargetValue	是	否	String	权重路由规则匹配目标取值
RouteRuleId	否	否	String	权重路由规则所属路由ID

GetClusterLimitResourceResultV2

获取集群limit资源(GetClusterLimitResource)返回对象

被如下接口引用：

名称	必选	允许NULL	类型	描述
CpuLimit	是	否	String	最大分配cpu 核数
MemLimit	是	否	String	最大分配mem内存数，单位M

TsfPageInstance

TSF机器实例分页对象

被如下接口引用：DescribeAddibleInstances、DescribeClusterInstances、DescribeGroupAddibleInstances、DescribeGroupInstances、DescribeSimpleInstances

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	机器实例总数目
Content	是	是	Array of Instance	机器实例列表

InstanceV2

机器实例

被如下接口引用：

名称	必选	允许NULL	类型	描述
InstanceId	是	是	String	机器ID
InstanceName	是	是	String	机器名称
LanIp	是	是	String	机器内网地址ip
WanIp	是	是	String	机器外网地址ip
InstanceDesc	是	是	String	机器描述信息
ClusterId	是	是	String	集群ID
ClusterName	是	是	String	集群名称
InstanceStatus	是	是	String	VM的状态虚机：虚机的状态容器：Pod所在虚机的状态
InstanceAvailableStatus	是	是	String	VM的可使用状态虚机：虚机是否能够作为资源使用容器：虚机是否能够作为资源部署POD
ServiceInstanceStatus	是	是	String	服务下的服务实例的状态虚机：应用是否可用 + Agent状态容器：Pod状态
CountInTsf	是	是	Int64	标识此instance是否已添加在tsf中
GroupId	是	是	String	机器所属分组Id
ApplicationId	是	是	String	机器所属应用Id
ApplicationName	是	是	String	机器所属应用名称
InstanceCreatedTime	是	是	String	机器实例在cvm的创建时间
InstanceExpiredTime	是	是	String	机器实例在CVM的过期时间
InstanceChargeType	是	是	String	机器实例在CVM的计费模式
InstanceTotalCpu	是	是	Float	机器实例总CPU信息
InstanceTotalMem	是	是	Float	机器实例总内存信息
InstanceUsedCpu	是	是	Float	机器实例使用的CPU信息
InstanceUsedMem	是	是	Float	机器实例使用的内存信息
InstanceLimitCpu	是	是	Float	机器实例limitCPU信息
InstanceLimitMem	是	是	Float	机器实例limit内存信息
InstancePkgVersion	是	是	String	包版本
ClusterType	是	是	String	集群类型
RestrictState	是	是	String	机器实例业务状态
UpdateTime	是	是	String	最后更新时间
OperationState	是	是	Int64	实例执行状态

TxMainTransactionV2

主事务描述

被如下接口引用：

名称	必选	允许NULL	类型	描述
TransactionId	是	是	String	事务Id
ServerIp	是	是	String	服务器Ip
ServiceName	是	是	String	服务名称
MethodName	是	是	String	方法名
SubCount	是	是	Int64	子事务数量
CreateTime	是	是	String	创建时间
UpdateTime	是	是	String	更新时间
Status	是	是	Int64	事务状态
TimeoutMs	是	是	Int64	超时时间
RetryTimes	是	是	Int64	重试次数
AutoRetry	是	是	Bool	是否开启自动重试

LicenseGrantee

被如下接口引用：DescribeLicenseApplications、IssueLicense、UploadLicenseApplication

名称	必选	允许NULL	类型	描述
Name	否	是	String	被授予者名称

InterfaceRequests

多条接口请求详情

被如下接口引用：DescribeInterfaceRequest

名称	必选	允许NULL	类型	描述
Content	是	是	Array of InterfaceRequest	interfaceRequest数组
TotalCount	是	是	Int64	总条数

ScalableSubRule

弹性扩缩容监控指标类型

被如下接口引用：CreateScalableRule、ModifyScalableRule

名称	必选	允许NULL	类型	描述
Indicators	是	否	Uint64	监控指标的阈值。如指标为 CPU 利用率或内存利用率，则为百分比 0-100；如指标为响应时间或请求个数，则为 0-99999999
IndicatorType	是	否	Uint64	规则指标类型: 1: CPU 利用率, 2: 内存利用率, 3: 请求响应时间, 4: 请求个数

BillingDeal

计费订单

被如下接口引用：DescribeBillingDealRecords

名称	必选	允许NULL	类型	描述
DealName	是	是	String	订单号
ResourceId	是	是	String	资源ID
CategoryId	是	是	Int64	种类ID
CreateTime	是	是	String	创建时间
AppId	是	是	String	租户ID
Uin	是	是	String	账号ID
SubAccountUin	是	是	String	子账号ID
Currency	是	是	String	币种
TotalCost	是	是	Int64	原价（单位分）
RealTotalCost	是	是	Int64	折后价（单位分）
TotalPolicy	是	是	Int64	总折扣
CommonPolicy	是	是	Int64	官网折扣
UserPolicy	是	是	Int64	用户折扣
DealDetail	是	是	String	订单详情

IndicatorCoord

监控指标坐标

被如下接口引用：DescribeInovcationIndicators

名称	必选	允许NULL	类型	描述
CoordX	是	是	String	指标横坐标值
CoordY	是	是	String	指标纵坐标值
CoordTag	是	是	String	指标标签，用于标识附加信息

ContainerEvent

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

被如下接口引用：DescribeContainerEvents

名称	必选	允许NULL	类型	描述
FirstTimestamp	否	是	Int64	第一次出现的时间，以 ms 为单位的时间戳
LastTimestamp	否	是	Int64	最后一次出现的时间，以 ms 为单位的时间戳
Type	否	是	String	级别
Kind	否	是	String	资源类型
Name	否	是	String	资源名称
Reason	否	是	String	内容
Message	否	是	String	详细描述
Count	否	是	Int64	出现次数

GatewayPluginId

微服务网关插件Id

被如下接口引用：CreateGatewayJwtPlugin、CreateGatewayOAuthPlugin、CreateGatewayQQMiniProgramLoginPlugin、CreateGatewayTagPlugin、CreateGatewayWeChatMiniProgramLoginPlugin

名称	必选	允许NULL	类型	描述
PluginId	是	否	String	网关插件ID

SchedulingStrategy

tsf 容器集群节点调度策略

被如下接口引用：DeployContainerGroup

名称	必选	允许NULL	类型	描述
Type	是	是	String	NONE：不使用调度策略；CROSS_AZ：跨可用区部署

DescribeResourceConfigLicense

DescribeResourceConfig

被如下接口引用：DescribeResourceConfig

名称	必选	允许NULL	类型	描述
Function	是	是	Array of DescribeResourceConfigLicenseFunction	功能
Resource	是	是	Array of DescribeResourceConfigLicenseResource	资源
ExpireTime	是	是	Uint64	utc时间单位秒
Countdown	是	是	Uint64	utc时间单位秒
Spec	是	是	String	规格

ApiGroupInfo

API分组信息

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

名称	必选	允许NULL	类型	描述
GroupId	是	是	String	Api Group Id
GroupName	是	是	String	Api Group 名称
GroupContext	是	是	String	分组上下文
AuthType	是	是	String	鉴权类型。 secret：密钥鉴权； none:无鉴权
Status	是	是	String	发布状态, drafted: 未发布。 released: 发布
CreatedTime	是	是	String	分组创建时间如:2019-06-20 15:51:28
UpdatedTime	是	是	String	分组更新时间如:2019-06-20 15:51:28
BindedGatewayDeployGroups	是	是	Array of GatewayDeployGroup	api分组已绑定的网关部署组
ApiCount	是	是	Int64	api 个数
AclMode	是	是	String	访问group的ACL类型
Description	是	是	String	描述
GroupType	是	是	String	分组类型。 ms：微服务分组； external:外部Api分组

ProductHelp

产品帮助

被如下接口引用：DescribeProductHelp、ReleaseProductHelp

名称	必选	允许NULL	类型	描述
HelpId	否	是	String	id
Content	否	是	String	内容
Link	否	是	String	链接
Order	否	是	Int64	排序
StyleFlag	否	是	String	样式Flag
Valid	否	是	Int64	是否有效
ValidTime	否	是	String	生效时间（当valid从0 -> 1，刷新生效时间）
Title	否	是	String	标题
ServiceTag	否	是	String	产品标识(默认为tsf)

ApplicationForPageV2

分页的应用描述信息字段

被如下接口引用：

名称	必选	允许NULL	类型	描述
ApplicationId	是	是	String	应用Id
ApplicationName	是	是	String	应用名称
ApplicationDesc	是	是	String	应用描述
ApplicationType	是	是	String	应用类型
MicroserviceType	是	是	String	微服务类型
ProgLang	是	是	String	编程语言
CreateTime	是	是	String	创建时间
UpdateTime	是	是	String	更新时间

LicenseFunction

被如下接口引用：DescribeLicenseApplications

名称	必选	允许NULL	类型	描述
Name	是	否	String	功能名
Enable	是	否	Bool	是否启用

TaskRecordSimpleInfo

任务基本信息

被如下接口引用：DescribeFlowAvailableTasks

名称	必选	允许NULL	类型	描述
TaskId	是	否	String	任务ID
TaskName	是	否	String	任务名称

ConfigSummaryV2

配置项统计信息，其实就是Config的部分字段

被如下接口引用：

名称	必选	允许NULL	类型	描述
ConfigName	是	否	String	配置项名称
ConfigVersionCount	是	否	Int64	配置项值
LastUpdateTime	是	否	String	配置项类型
ApplicationId	是	否	String	应用ID
ApplicationName	是	否	String	应用名称

BusinesLogConfigAssociatedGroupV2

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

被如下接口引用：

名称	必选	允许NULL	类型	描述
GroupId	是	是	String	部署组ID
GroupName	是	是	String	部署组名称
ApplicationId	是	是	String	部署组所属应用ID
ApplicationName	是	是	String	部署组所属应用名称
ApplicationType	是	是	String	部署组所属应用类型
NamespaceId	是	是	String	部署组所属命名空间ID
NamespaceName	是	是	String	部署组所属命名空间名称
ClusterId	是	是	String	部署组所属集群ID
ClusterName	是	是	String	部署组所属集群名称
ClusterType	是	是	String	部署组所属集群类型
AssociatedTime	是	是	String	部署组关联日志配置时间

DescribeResourceConfigCluster

返回给前端的控制信息

被如下接口引用：DescribeResourceConfig

名称	必选	允许NULL	类型	描述
Container	是	是	DescribeResourceConfigClusterContainer	返回给前端的控制信息

PagedPermCat

tsf-privilege模块，分页权限组列表

被如下接口引用：DescribePermissionCategories

名称	必选	允许NULL	类型	描述
TotalCount	否	否	Int64	总条数
Content	是	否	Array of PermCat	产品列表

StatisticsCoord

指标坐标

被如下接口引用：

名称	必选	允许NULL	类型	描述
CoordX	是	是	String	指标横坐标值
CoordY	是	是	String	指标纵坐标值
CoordTag	是	是	String	指标标签，用于标识附加信息

GraphNodeV2

依赖拓扑图节点

被如下接口引用：GetOssTopologyGraph、GetTopologyGraph

名称	必选	允许NULL	类型	描述
Name	是	是	String	节点服务名
Type	是	是	String	节点服务类型
ReqTotalQty	是	是	Uint64	节点服务总请求量
ReqAvgQty	是	是	Float	节点请求平均数，次每分钟，两位小数
ReqSuccessRate	是	是	Float	节点请求成功率，两位小数
ReqAvgDuration	是	是	Float	节点请求平均耗时，单位毫秒，两位小数
EdgeList	是	是	Array of GraphEdgeV2	节点服务为目的的边列表（入度）
Id	是	是	String	节点标识符
NamespaceId	是	是	String	节点命名空间ID

ListTsfZoneResult

被如下接口引用：DescribeTsfmanagerZones、DescribeZones

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	TotalCount
Content	是	是	Array of TsfZoneResult	Content

PurchaseInfo

购买信息

被如下接口引用：DescribeUserPurchaseInfo

名称	必选	允许NULL	类型	描述
CanPurchase	是	否	Bool	true 表示可以新购，false 时能够续费
Spec	是	是	String	规格
NodeSize	是	是	Int64	节点数
ExpireTime	是	是	Int64	过期时间 utc时间单位秒
ResourceId	是	是	String	资源ID
Label	是	是	String	询价参数 key
RenewFlag	是	是	Int64	自动续费标记，0 默认，1 自动续费，2 不自动续费
CanModify	是	是	Bool	CanPurchase 为 false 时，用于判断能否变配
LabelValue	是	是	Int64	询价参数 value

ProjectList

被如下接口引用：

名称	必选	允许NULL	类型	描述
ProjectId	是	否	String	工程id
ProjectName	是	否	String	工程名
BasePackage	是	否	String	包路径
LastTime	是	否	Int64	修改时间
AppId	否	否	String	AppId
Uin	否	否	String	Uin
SubAccountUin	否	否	String	SubAccountUin
Data	否	否	String	Data

ImageTagsResultV2

镜像版本列表

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	总记录数
Reponame	是	否	String	仓库名,含命名空间,如tsf/ngin
Server	是	否	String	镜像服务器地址
Content	是	否	Array of ImageTag	列表信息

TsfPageConfigReleaseLog

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

被如下接口引用：DescribeConfigReleaseLogs、DescribePublicConfigReleaseLogs

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总条数
Content	是	是	Array of ConfigReleaseLog	配置项发布日志数组

TsfMiscroserviceApi

被如下接口引用：

名称	必选	允许NULL	类型	描述
Id	是	是	String	微服务ID
Path	是	是	String	路径
Method	是	否	String	方法
PkgVersion	是	否	String	包版本
ApplicationId	是	否	String	应用ID
MicroserviceId	是	否	String	微服务ID
NamespaceId	是	否	String	命名空间ID
MicroserviceName	是	否	String	微服务名称
Description	是	否	String	描述

ModulesDetailResult

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	TotalCount
Content	是	是	Array of ModulesResult	Content

TaskFlowLogPage

工作流列表

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	数据总数
Content	是	否	Array of TaskFlowLog	工作流数据列表

ContainerGroupResourceConfig

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

被如下接口引用：DescribeResourceConfig

名称	必选	允许NULL	类型	描述
AdditionalResourceRequirement	是	是	ContainerAdditionalResourceRequirementMap	不同类型的应用的容器部署组，部署时的额外资源要求

GatewayInstance

网关实体（单元化后使用）

被如下接口引用：DescribeGatewayInstance、DescribeGatewayInstances

名称	必选	允许NULL	类型	描述
Id	是	是	String	网关实体ID
ServiceId	是	是	String	微服务ID（ms-xxx）
ServiceName	是	是	String	微服务名
NamespaceId	是	是	String	命名空间ID
NamespaceName	是	是	String	命名空间名
Type	是	是	String	网关实例类型：单元化(unit)/非单元化网关(none)
ConsulInstanceCount	是	是	Int64	注册中心在线节点数

ProductNews

产品动态

被如下接口引用：DescribeProductNews、ReleaseProductNews

名称	必选	允许NULL	类型	描述
NewsId	否	是	String	id
Content	否	是	String	内容
Link	否	是	String	链接
Order	否	是	Int64	排序
StyleFlag	否	是	String	样式Flag
Valid	否	是	Int64	是否有效
ValidTime	否	是	String	生效时间（当valid从0 -> 1，刷新生效时间）
Title	否	是	String	标题
ServiceTag	否	是	String	产品标识(默认为tsf)

OverviewMsResult

概览页微服务信息

被如下接口引用：DescribeOverviweService

名称	必选	允许NULL	类型	描述
RunMicroserviceCount	是	是	Int64	概览页微服务数目

ApplicationServerResult

被如下接口引用：ListApplicationServers

名称	必选	允许NULL	类型	描述
ServerId	是	是	String	ServerId
ClusterId	是	是	String	ClusterId
GroupId	是	是	String	GroupId
Ip	是	是	String	Ip
Type	是	是	Int64	Type
TaskStatus	是	是	Int64	TaskStatus
AgentStatus	是	是	Int64	AgentStatus
MasterId	是	是	Int64	MasterId
GroupDesc	是	是	String	GroupDesc
BasicEnvDesc	是	是	String	BasicEnvDesc
ApplicationType	是	是	String	ApplicationType
AgentVersion	是	是	String	AgentVersion

ContainerVolumeOption

容器卷挂载信息

被如下接口引用：DescribeContainerVolumeOptions

名称	必选	允许NULL	类型	描述
ConfigMap	否	否	VolumeItem	ConfigMap配置
Secret	否	否	VolumeItem	Secret配置
PersistentVolumeClaim	否	否	VolumeItem	Pvc配置

SidecarStatus

sidecar 状态

被如下接口引用：DescribeMeshSidecarStatus

名称	必选	允许NULL	类型	描述
Envoy	是	是	String	envoy状态
MeshDns	是	否	String	mesh-dns 状态
PilotAgent	是	否	String	pilot-agent状态

VmInstanceResourceConfig

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

被如下接口引用：DescribeResourceConfig

名称	必选	允许NULL	类型	描述
ImportMode	是	是	Array of String	实例导入方式，可多个，公有云为 ["R", "M"]，独立版的取值仅有 "M" 脚本模式

Microservice

微服务

被如下接口引用：DescribeMicroservices、DescribeMicroservicesByGroupIds、DescribeServiceNames

名称	必选	允许NULL	类型	描述
MicroserviceId	否	是	String	微服务ID
MicroserviceName	否	是	String	微服务名称
MicroserviceDesc	否	是	String	微服务描述
CreateTime	否	是	Int64	创建时间
UpdateTime	否	是	Int64	更新时间
NamespaceId	否	是	String	命名空间ID
RunInstanceCount	否	是	Int64	微服务的运行实例数目
CriticalInstanceCount	否	是	Int64	微服务的离线实例数目

TsfPageVmSubTask

虚拟机子任务分页信息

被如下接口引用：DescribeSubTasks

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	子任务总数目
SuccessCount	是	是	Int64	成功子任务数目
RunCount	是	是	Int64	运行中子任务数目
FailCount	是	是	Int64	失败子任务数目
Content	是	是	Array of VmSubTask	子任务列表信息

GatewayPluginInstance

微服务插件实例明细

被如下接口引用：

名称	必选	允许NULL	类型	描述
PluginInstanceId	是	否	String	插件实例ID
Id	是	否	String	插件ID
Name	是	否	String	插件名称
Description	是	是	String	插件描述
PluginId	是	否	String	插件ID
Type	是	否	String	插件类型
CreatedTime	是	否	String	插件创建时间如:2019-06-20 15:51:28
UpdatedTime	是	否	String	插件更新时间如:2019-06-20 15:51:28

VportTypeResult

被如下接口引用：ListTsfModulesDetail、ModifyModuleConf

名称	必选	允许NULL	类型	描述
VportId	是	是	String	VportId
ModuleId	是	是	String	ModuleId
VportType	是	是	String	VportType
DefaultVport	是	是	String	DefaultVport
Vport	是	是	String	Vport

Tag

标签

被如下接口引用：DescribeLicenses

名称	必选	允许NULL	类型	描述
TagKey	否	是	String	标签键
TagValue	否	是	String	标签值

TsfPageRegion

TSF地域列表对象

被如下接口引用：DescribeTsfRegions

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	TSF地域总数目
Content	是	是	Array of TsfRegion	TSF地域列表

LaneGroups

泳道部署组分页查询结果集

被如下接口引用：DescribeLaneGroups

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总个数
Content	是	是	Array of LaneGroup	泳道部署组列表

TaskBatchRecord

任务批次

被如下接口引用：DescribeTaskBatchHistoryRecords、DescribeTaskBatchRecord、DescribeTaskBatchRecords

名称	必选	允许NULL	类型	描述
BatchId	是	否	String	任务批次ID
TaskId	是	否	String	任务ID
State	是	否	String	任务状态
StartTime	是	是	Uint64	开始时间
EndTime	是	是	Uint64	结束时间
TotalCount	是	否	Uint64	总共数据
SuccessCount	是	否	Uint64	成功的任务数量
FailedCount	是	否	Uint64	失败的任务数量
TimeoutCount	是	否	Uint64	超时的任务数量
TerminateCount	是	否	Uint64	停止的任务数量
GroupId	是	是	String	任务分组ID
TaskName	是	是	String	任务名称
TaskLogId	是	否	String	任务历史 ID
BatchLogId	是	是	String	批次历史 ID
ScheduleFireTime	是	是	Int64	任务计划触发的时间点
FlowBatchId	是	是	String	工作流批次 ID
BatchType	是	是	String	批次类型
TriggerType	是	是	String	任务触发类型
FlowBatchLogId	是	是	String	工作流批次历史 ID
SuccessRatio	是	是	Int64	执行成功率
HistoryCount	是	是	Int64	执行批次历史数量
SpanTime	是	是	Int64	耗时
FlowId	是	是	String	所属工作流ID
FlowName	是	是	String	所属工作流名称
FlowLogId	是	是	String	所属工作流历史ID

ScalableRuleAttributeV2

ScalableRuleAttribute

被如下接口引用：

名称	必选	允许NULL	类型	描述
RuleId	是	是	String	RuleId
Name	是	是	String	Name
EnableShrink	是	是	Int64	EnableShrink
EnableExpand	是	是	Int64	EnableExpand
ExpandPeriod	是	是	Int64	ExpandPeriod
ShrinkPeriod	是	是	Int64	ShrinkPeriod
ExpandVmCount	是	是	Int64	ExpandVmCount
ShrinkVmCount	是	是	Int64	ShrinkVmCount
CoolTime	是	是	Int64	CoolTime
ExpandVmCountLimit	是	是	Int64	ExpandVmCountLimit
ShrinkVmCountLimit	是	是	Int64	ShrinkVmCountLimit
ExpandSubruleList	是	是	Array of ExpandSubrule	ExpandSubruleList
ShrinkSubruleList	是	是	Array of ExpandSubrule	ShrinkSubruleList
CreateTime	是	是	String	CreateTime
UpdateTime	是	是	String	UpdateTime

KafkaDeliveryConfig

投递kafka配置项

被如下接口引用：DescribeDeliveryConfig

名称	必选	允许NULL	类型	描述
ConfigId	是	是	String	配置项id
ConfigName	是	是	String	配置名称
CollectPath	是	是	Array of String	采集路径
KafkaVIp	是	是	String	kafka vip
KafkaVPort	是	是	String	kafka vport
Topic	是	是	String	kafka topic
LineRule	是	是	String	换行规则

DeliveryConfigBindGroups

描述配置项绑定的部署组

被如下接口引用：DescribeDeliveryConfigs

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	公共条数
Content	是	是	Array of DeliveryConfigBindGroup	内容

TsfPageImageInfo

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Uint64	TotalCount
Content	是	是	Array of ImageInfo	TsfPageImageInfo详情

ListScalableRuleResultV2

ListScalableRuleResult

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	TotalCount
Content	是	是	Array of ScalableRule	Content

RecordResourceTypeNameV2

操作记录资源类型名称

被如下接口引用：

名称	必选	允许NULL	类型	描述
ResourceType	是	是	String	操作记录资源类型
ResourceTypeName	是	是	String	操作记录资源类型名称

ImageRepositoryV2

镜像仓库

被如下接口引用：

名称	必选	允许NULL	类型	描述
Reponame	是	是	String	仓库名,含命名空间,如tsf/nginx
Repotype	是	是	String	仓库类型
TagCount	是	是	Int64	镜像版本数
IsPublic	是	是	Int64	是否公共,1:公有,0:私有
IsUserFavor	是	是	Bool	是否被用户收藏。true：是，false：否
IsQcloudOfficial	是	是	Bool	是否是腾讯云官方仓库。是否是腾讯云官方仓库。true：是，false：否
FavorCount	是	是	Int64	被所有用户收藏次数
PullCount	是	是	Int64	拉取次数
Description	是	是	String	描述内容
CreationTime	是	是	String	创建时间
UpdateTime	是	是	String	更新时间

ConfigRelease

配置项发布信息

被如下接口引用：DescribeConfigReleases、DescribePublicConfigReleases

名称	必选	允许NULL	类型	描述
ConfigReleaseId	是	是	String	配置项发布ID
ConfigId	是	是	String	配置项ID
ConfigName	是	是	String	配置项名称
ConfigVersion	是	是	String	配置项版本
ReleaseTime	是	是	String	发布时间
GroupId	是	是	String	部署组ID
GroupName	是	是	String	部署组名称
NamespaceId	是	是	String	命名空间ID
NamespaceName	是	是	String	命名空间名称
ClusterId	是	是	String	集群ID
ClusterName	是	是	String	集群名称
ReleaseDesc	是	是	String	发布描述
ApplicationId	是	是	String	应用ID

ResourceStatus

模块资源的使用情况

被如下接口引用：DescribeResourceUsageRate

名称	必选	允许NULL	类型	描述
Used	是	否	Uint64	该模块多个节点的总的资源使用量
Total	是	否	Uint64	该模块的多个节点的总的资源量
NodesStatus	是	否	Array of ResourceNodeStatus	各个节点的资源的情况

InvocationMetricDataPoint

被如下接口引用：DescribeUnitApiUseDetail

名称	必选	允许NULL	类型	描述
Key	是	是	String	Key
Value	是	是	String	Value
Tag	是	是	String	Tag

OverviewBasicResourceUsage

TSF基本资源信息概览

被如下接口引用：DescribeBasicResourceUsage

名称	必选	允许NULL	类型	描述
ApplicationCount	是	是	Int64	应用总数
NamespaceCount	是	是	Int64	命名空间总数
GroupCount	是	是	Int64	部署组个数
PackageSpaceUsed	是	是	Int64	程序包存储空间用量，单位字节
ConsulInstanceCount	是	是	Int64	已注册实例数

ModulesResult

被如下接口引用：ListTsfModulesDetail

名称	必选	允许NULL	类型	描述
ModuleId	是	是	String	ModuleId值
ModuleName	是	是	String	ModuleName值
ModuleType	是	是	String	ModuleType值
ExternalVip	是	是	String	ExternalVip值
InternalVip	是	是	String	InternalVip值
Vports	是	是	Array of VportTypeResult	Vports值
Instances	是	是	Array of InstancesResult	Instances值
AlarmType	是	是	String	AlarmType值
ModuleCommon	是	是	Int64	ModuleCommon值
DeployOrder	是	是	Int64	DeployOrder值
Visible	是	是	String	Visible值
ViportVisible	是	是	Bool	ViportVisible值
HasRole	是	是	Bool	HasRole值
Password	是	是	String	Password值
HasRoleStr	是	是	String	HasRoleStr值

MsApiArray

微服务API数组

被如下接口引用：DescribeInterfaceList、DescribeMsApiList

名称	必选	允许NULL	类型	描述
Path	是	否	String	API 请求路径
Method	是	否	String	请求方法
Description	是	是	String	方法描述
Status	是	是	Int64	API状态 0:离线 1:在线

TsfPageBillingDeal

BillingDeal 翻页对象

被如下接口引用：DescribeBillingDealRecords

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Uint64	记录总数
Content	是	是	Array of BillingDeal	记录实体列表

RouteAffinity

路由规则就近访问策略

被如下接口引用：DescribeNamespaceAffinities

名称	必选	允许NULL	类型	描述
NamespaceId	是	否	String	命名空间ID
Affinity	是	是	Bool	就近访问策略是否开启
AffinityId	是	是	String	就近访问策略ID
UpdateTimestamp	是	是	String	就近访问策略更新时间

TemplateProject

ProjectList

被如下接口引用：DescribeTemplates

名称	必选	允许NULL	类型	描述
ProjectId	是	是	String	工程id
ProjectName	是	是	String	工程名
BasePackage	是	是	String	包路径
LastTime	是	是	Int64	修改时间
Data	否	是	String	Data
AppId	否	是	String	AppId
Uin	否	是	String	Uin
SubAccountUin	否	是	String	SubAccountUin

ApiResponseDescr

API 响应的参数结构描述

被如下接口引用：DescribeApiDetail

名称	必选	允许NULL	类型	描述
Name	是	否	String	参数描述
Type	是	否	String	参数类型
Description	是	否	String	参数描述

CloudMonitorPolicyResultV2

云监控对象策略对象

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	TotalCount
Content	是	是	Array of CloudMonitorPolicies	Content

VmSubTask

虚拟机子任务信息

被如下接口引用：DescribeSubTasks

名称	必选	允许NULL	类型	描述
InstanceId	是	是	String	机器Id
LanIp	是	是	String	内网IP
WanIp	是	是	String	外网IP
InstanceName	是	是	String	机器名称
AgentState	是	是	Int64	机器Agent状态
InstanceState	是	是	Int64	机器状态
TaskStatus	是	是	Int64	任务状态
TaskRecord	是	是	String	任务记录

CosCredentials

cos临时帐号信息

被如下接口引用：CheckUploadInfo、DescribeDownloadInfo、DescribeUploadInfo、GetDownloadInfo、GetUploadInfo

名称	必选	允许NULL	类型	描述
SessionToken	是	是	String	会话Token
TmpAppId	是	是	String	临时应用ID
TmpSecretId	是	是	String	临时调用者身份ID
TmpSecretKey	是	是	String	临时密钥
ExpiredTime	是	是	Int64	过期时间
Domain	是	是	String	所在域

ZipkinSpanInfo

调用链Span信息

被如下接口引用：GetTraceSpans

名称	必选	允许NULL	类型	描述
Id	是	是	String	Span ID
TraceId	是	是	String	调用链ID
ParentId	是	是	String	父Span ID
Name	是	是	String	Span名称
Timestamp	是	是	Uint64	Span时间戳
Duration	是	是	Uint64	Span耗时
ResultStatus	是	是	String	Span结果
ServiceName	是	是	String	Span服务名（前端展示）
AnnotationList	是	是	Array of ZipkinAnnotation	Span注解列表
BinaryAnnotationList	是	是	Array of ZipkinBinaryAnnotation	Span二进制注解列表
MetadataList	是	是	Array of ZipkinMetadata	Span元数据列表

RatelimitDimension

限流规则作用的标签维度

被如下接口引用：CreateRatelimit、DescribeRatelimit、UpdateRatelimit

名称	必选	允许NULL	类型	描述
TagType	是	否	String	`S`: 系统标签/`U`: 自定义标签
TagField	是	否	String	标签名
TagOperator	是	否	String	EQUAL/NOT_EQUAL/IN/NOT_IN/REGEX
TagValue	是	否	String	标签匹配值

TxError

事务查询异常信息

被如下接口引用：AutoRetryTransaction、DescribeTransactions、RetryTransaction

名称	必选	允许NULL	类型	描述
Code	是	是	String	错误码
Message	是	是	String	错误信息

ConfigReleaseLogV2

配置项发布日志

被如下接口引用：

名称	必选	允许NULL	类型	描述
ConfigReleaseLogId	是	是	String	配置项发布日志ID
ConfigId	是	是	String	配置项ID
ConfigName	是	是	String	配置项名称
ConfigVersion	是	是	String	配置项版本
GroupId	是	是	String	部署组ID
GroupName	是	是	String	部署组名称
NamespaceId	是	是	String	命名空间ID
NamespaceName	是	是	String	命名空间名称
ClusterId	是	是	String	集群ID
ClusterName	是	是	String	集群名称
ReleaseTime	是	是	String	发布时间
ReleaseDesc	是	是	String	发布描述
ReleaseStatus	是	是	String	发布状态
LastConfigId	是	是	String	上次发布的配置项ID
LastConfigName	是	是	String	上次发布的配置项名称
LastConfigVersion	是	是	String	上次发布的配置项版本
RollbackFlag	是	是	Bool	回滚标识

DescribeContainerTasksResult

被如下接口引用：DescribeContainerTasks

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	列表总数
Content	是	是	Array of ContainerTasks	列表内容

VmGroupV2

虚拟机部署组信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
GroupId	是	是	String	分组Id
GroupName	是	是	String	分组名称
GroupStatus	是	是	String	分组状态
PackageId	是	是	String	程序包Id
PackageName	是	是	String	程序包名称
PackageVersion	是	是	String	程序包版本号
ClusterId	是	是	String	集群Id
ClusterName	是	是	String	集群名称
NamespaceId	是	是	String	命名空间Id
NamespaceName	是	是	String	命名空间名称
ApplicationId	是	是	String	应用Id
ApplicationName	是	是	String	应用名称
InstanceCount	是	是	Int64	分组机器数目
RunInstanceCount	是	是	Int64	分组运行中机器数目
StartupParameters	是	是	String	部署组启动参数信息
CreateTime	是	是	String	分组创建时间
UpdateTime	是	是	String	分组更新时间
OffInstanceCount	是	是	String	分组停止机器数目
GroupDesc	是	是	String	分组描述信息
MicroserviceType	是	是	String	微服务类型

ImageUserIsExistsResult

被如下接口引用：DescribeImageUserIsExists

名称	必选	允许NULL	类型	描述
Data	是	是	ImageUserIsExists	用户是否存在

Consumer

被如下接口引用：CreateAndDownloadTemplate、CreateTemplate

名称	必选	允许NULL	类型	描述
ConsumerControllerName	是	是	String	ConsumerControllerName
ToProviderName	是	是	String	ToProviderName
ToProviderServiceName	是	是	String	ToProviderServiceName

SimpleApplication

简单应用

被如下接口引用：DescribeSimpleApplications

名称	必选	允许NULL	类型	描述
ApplicationId	是	是	String	应用ID
ApplicationName	是	是	String	应用名称
ApplicationType	是	是	String	应用类型
MicroserviceType	是	是	String	应用微服务类型
ApplicationDesc	是	是	String	ApplicationDesc
ProgLang	是	是	String	ProgLang
ApplicationResourceType	是	是	String	ApplicationResourceType
CreateTime	是	是	String	CreateTime
UpdateTime	是	是	String	UpdateTime
ApigatewayServiceId	是	是	String	ApigatewayServiceId
ApplicationRuntimeType	是	是	String	ApplicationRuntimeType
ApplicationRemarkName	否	否	String	应用备注

TsfPageAuthorizationV2

虽然挂着 TsfPage，但是它没有继承 TsfPage 类（后面可能会）。这是个全量接口。

被如下接口引用：

名称	必选	允许NULL	类型	描述
IsEnabled	是	否	Bool	鉴权规则是否被启用
Conditions	是	是	Array of AuthCondition	鉴权规则列表

MetricDataPoint

监控统计数据点

被如下接口引用：DescribeGWOverviewInvocation、DescribeInvocationMetricDataCurve、DescribeOverviewInvocation、DescribeStatistics

名称	必选	允许NULL	类型	描述
Key	是	是	String	数据点键
Value	是	是	String	数据点值
Tag	是	是	String	数据点标签

OperationInfo

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

被如下接口引用：DescribeCluster、DescribeClusterInstanceCount、DescribeClusters、DescribeNamespaces、DescribeSimpleClusters、DescribeSimpleNamespaces

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

TsfPageApiGroupInfo

ApiGroupInfo翻页结构体

被如下接口引用：DescribeApiGroups、DescribeGroupGateways、DescribeGroupsWithPlugin

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	总记录数
Content	是	否	Array of ApiGroupInfo	API分组信息

RepositoryErrorV2

仓库相关错误

被如下接口引用：

名称	必选	允许NULL	类型	描述
Code	是	是	String	无
Message	是	是	String	无

GatewayJwtPlugin

微服务网关JWT插件

被如下接口引用：DescribeGatewayJwtPlugin

名称	必选	允许NULL	类型	描述
Id	是	是	String	网关插件id
Name	是	是	String	插件名称
Description	是	是	String	插件描述
Type	是	是	String	插件类型
CreatedTime	是	是	String	插件创建时间如:2019-06-20 15:51:28
UpdatedTime	是	是	String	插件更新时间如:2019-06-20 15:51:28
Kid	是	是	String	公钥标识
PublicKeyJson	是	是	String	公钥对
RedirectUrl	是	是	String	重定向地址
TokenBaggagePosition	是	是	String	token携带位置，网关取token位置与发送认证请求时token位置一致,值:query/header
TokenKeyName	是	是	String	token的key值
ClaimMappingJson	是	是	String	claim参数映射关系json
Status	是	是	String	发布状态: drafted/released

QuantileEntity

分位数据模型

被如下接口引用：DescribeApiUseDetail、DescribeUnitApiUseDetail

名称	必选	允许NULL	类型	描述
MaxValue	是	是	String	最大值
MinValue	是	是	String	最小值
FifthPositionValue	是	是	String	五分位值
NinthPositionValue	是	是	String	九分位值

JavaInstance

DescribeJavaInstance接口返回的一系列指标封装

被如下接口引用：DescribeJavaInstance

名称	必选	允许NULL	类型	描述
InstanceId	是	是	String	实例Id
ElapsedTime	是	是	Int64	服务运行时间, 单位秒
CupConsumingTime	是	是	Int64	cpu消耗总时长, 单位秒
JitCompileTime	是	是	Int64	服务JIT编译时间, 单位秒
HeapUsed	是	是	Int64	已用堆大小,单位KB
HeapFree	是	是	Int64	可用堆大小,单位KB
HeapSize	是	是	Int64	堆大小总量,单位KB
HeapCommitted	是	是	Int64	commit堆内存, 单位KB
WaitBuildObjectCount	是	是	Int64	等待构析的对象数量
YoungGcCount	是	是	Int64	产生Young GC总次数
FullGcCount	是	是	Int64	产生Full GC总次数
YoungGcConsumingTime	是	是	Int64	Young GC总耗时长, 单位秒
FullGcCountConsumingTime	是	是	Int64	Full GC总耗时长, 单位秒
ActiveThreadCount	是	是	Int64	活跃线程数
CpuPercent	是	是	Int64	cpu使用率
StatusInfo	是	是	String	异步执行错误时,各种错误信息
StatusCode	是	是	Int64	异步执行错误时,对应的错误码

PkgBind

描述程序包关联信息

被如下接口引用：DescribePkgs、ListPkg

名称	必选	允许NULL	类型	描述
ApplicationId	是	是	String	应用id
GroupId	是	是	String	部署组id

ContainerTasksV2

变更记录任务

被如下接口引用：

名称	必选	允许NULL	类型	描述
TaskId	是	是	String	taskId
TaskTime	是	是	String	任务开始时间
Type	是	是	Int64	任务类型字段，0：没有任务（在此接口中，不用出现0），1：发布程序包；2.部署操作；3.扩容操作；4.启动操作；5.停止操作；6.缩容操作；7.发布日志配置,8.删除销毁操作
Status	是	是	Int64	变更状态，0：成功 1:失败 2：执行中
GroupId	是	是	String	分组id
GroupName	是	是	String	分组名称
ImageName	是	是	String	镜像名称
ImageVersion	是	是	String	镜像版本
TaskDesc	是	是	String	任务详情描述
TotalCount	是	是	Int64	任务总个数
SuccessCount	是	是	Int64	成功任务个数
FailCount	是	是	Int64	失败任务个数

StdoutLog

标准输出日志

被如下接口引用：

名称	必选	允许NULL	类型	描述
InstanceId	是	是	String	实例ID
Content	是	是	String	日志内容
Timestamp	是	是	Uint64	日志时间戳

TsfPageSimpleApplicationV2

TSF分页简单应用对象

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总条数
Content	是	是	Array of SimpleApplication	简单应用列表

OverviewLicenseResourceUsage

license相关信息概览

被如下接口引用：DescribeLicenseInfo

名称	必选	允许NULL	类型	描述
ConsulInstanceCount	是	是	Int64	已注册实例数目

TsfBusinessLog

容器日志输出

被如下接口引用：SearchContainerStdoutLog

名称	必选	允许NULL	类型	描述
RealtimeTs	否	是	Uint64	时间戳，入参传入，若不为实时日志，可能为空
ScrollId	否	是	Uint64	游标ID
BusinessLogSet	否	是	Array of BusinessLog	容器日志输出列表

GroupPodV2

部署组实例列表

被如下接口引用：

名称	必选	允许NULL	类型	描述
PodName	是	是	String	实例名称(对应到kubernetes的pod名称)
PodId	是	是	String	实例ID(对应到kubernetes的pod id)
Status	是	是	String	实例状态，请参考后面的实例以及容器的状态定义
Reason	是	是	String	实例处于当前状态的原因，例如容器下载镜像失败
NodeIp	是	是	String	主机IP
Ip	是	是	String	实例IP
RestartCount	是	是	Int64	实例中容器的重启次数
ReadyCount	是	是	Int64	实例中已就绪容器的个数
Runtime	是	是	String	运行时长
CreatedAt	是	是	String	实例启动时间
ServiceInstanceStatus	是	是	String	服务实例状态
InstanceAvailableStatus	是	是	String	机器实例可使用状态
InstanceStatus	是	是	String	机器实例状态

DtsBranch

DTS分支事务

被如下接口引用：

名称	必选	允许NULL	类型	描述
BranchId	是	是	Int64	分支事务ID
ParentId	是	是	Int64	父级分支事务ID，顶级时返回null
BranchBegin	是	是	Int64	分支事务开始时间戳，UTC，精确到毫秒
BranchEnd	是	是	Int64	分支事务结束时间戳，UTC，精确到毫秒
BranchType	是	是	Int64	分支事务类型
Name	是	是	String	分支事务名称
Status	是	是	Int64	分支事务状态
GroupId	是	是	String	事务分组ID
Server	是	是	String	分支事务来源服务标识
Params	是	是	String	分支运行参数，Json格式字符串
TxId	是	是	Int64	主事务ID

Ms

被如下接口引用：CreateAndDownloadTemplate、CreateTemplate

名称	必选	允许NULL	类型	描述
MsName	是	是	String	MsName
MsPort	是	是	String	MsPort
Controller	是	是	Array of Controller	Controller
Provider	是	是	Array of Provider	Provider
Consumer	是	是	Array of Consumer	Consumer

TaskFlowBatchPage

工作流翻页数据

被如下接口引用：DescribeFlowBatchHistoryRecords、DescribeFlowBatchRecords

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	数据总数
Content	是	否	Array of TaskFlowBatch	翻页数据

ApplicationServerLogContent

日志内容

被如下接口引用：DescribeApplicatoinServerLog

名称	必选	允许NULL	类型	描述
LogContent	是	否	String	日志内容
Timestamp	是	否	String	时间戳
LogType	是	否	String	日志类型

GatewayGroupApiVo

网关API简单信息

被如下接口引用：DescribeGatewayAllGroupApis

名称	必选	允许NULL	类型	描述
ApiId	是	否	String	API ID
Path	是	否	String	API 请求路径
MicroserviceName	是	否	String	API 微服务名称
Method	是	是	String	API 请求方法
NamespaceName	是	是	String	命名空间名称

RouteV2

路由规则信息

被如下接口引用：DescribeRoute、DescribeRoutes

名称	必选	允许NULL	类型	描述
RouteId	是	是	String	路由规则ID
RouteName	是	是	String	路由规则名称
RouteDesc	是	是	String	路由规则描述信息
MicroserviceId	是	是	String	微服务ID
EnableStatus	是	是	Bool	路由启用状态。true：路由规则为启用状态，。false：路由规则为停用状态
CreateTime	是	是	String	路由规则创建时间
UpdateTime	是	是	String	路由规则更新时间
NamespaceId	是	是	String	微服务所属命名空间ID
MicroserviceName	是	是	String	微服务名称
RuleList	是	是	Array of RouteRuleV2	路由规则包含路由规则项列表

CircuitBreakerRules

分页展示路由规则

被如下接口引用：DescribeCircuitBreakerRules

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	总数
Content	是	否	Array of CircuitBreakerRule	路由规则

SimpleApplicationV2

简单应用

被如下接口引用：

名称	必选	允许NULL	类型	描述
ApplicationId	是	是	String	应用ID
ApplicationName	是	是	String	应用名称
ApplicationType	是	是	String	应用类型
MicroserviceType	是	是	String	应用微服务类型

ContainerInfo

容器详细信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
Name	是	是	String	容器名
ContainerId	是	是	String	容器ID
Status	是	是	String	容器状态
Reason	是	是	String	容器的Reason
Image	是	是	String	镜像地址

ApiRequestDescr

被如下接口引用：DescribeApiDetail

名称	必选	允许NULL	类型	描述
Name	是	否	String	参数名称
Type	是	否	String	参数类型
In	是	否	String	参数位置
Description	是	否	String	参数描述
Required	是	否	Bool	参数是否必须
DefaultValue	是	是	String	参数的默认值

CommonPkg

公共包信息

被如下接口引用：DescribeCommonPkg

名称	必选	允许NULL	类型	描述
ApplicationName	是	否	String	公共包名
ApplicationId	是	否	String	包所属的应用ID，在微服务网关相关应用中使用
ApplicationDesc	是	否	String	包的描述信息
CallbackAction	是	否	String	回调接口
ServiceType	是	否	String	服务类型

Permission

权限点

被如下接口引用：

名称	必选	允许NULL	类型	描述
PermId	否	是	String	权限点ID
PermCode	否	是	String	权限点编码
PermDesc	否	是	String	权限点描述
ServiceCode	否	是	String	产品编码
CreationTime	否	是	Int64	创建时间
LastUpdateTime	否	是	Int64	最后更新时间
DeleteFlag	否	是	Bool	删除标识，true：可以删除；false：不可删除

ContainGroup

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

被如下接口引用：DescribeContainerGroups

名称	必选	允许NULL	类型	描述
GroupId	否	是	String	部署组ID
GroupName	否	是	String	分组名称
CreateTime	否	是	String	创建时间
Server	是	是	String	镜像server
RepoName	是	是	String	镜像名，如/tsf/nginx
TagName	是	是	String	镜像版本名称
ClusterId	是	是	String	集群ID
ClusterName	是	是	String	集群名称
NamespaceId	是	是	String	命名空间ID
NamespaceName	是	是	String	命名空间名称
CpuRequest	是	是	String	初始分配的 CPU 核数，对应 K8S request
CpuLimit	是	是	String	最大分配的 CPU 核数，对应 K8S limit
MemRequest	是	是	String	初始分配的内存 MiB 数，对应 K8S request
MemLimit	是	是	String	最大分配的内存 MiB 数，对应 K8S limit

MsApplicationV2

应用

被如下接口引用：

名称	必选	允许NULL	类型	描述
ApplicationId	否	是	String	应用 ID，如 application-qv3dkda7
ApplicationName	否	是	String	应用名
ApplicationDesc	否	是	String	应用描述
ApplicationType	否	是	String	应用部署类型，V 表示 CVM 应用，C 表示容器应用
ApplicationJvmArg	否	是	String	应用启动时的 JVM 参数
MicroserviceType	否	是	String	应用类型，M 表示 Mesh 应用，N 表示 Spring Cloud 应用
ProgLang	否	是	String	应用编程语言，J 表示 Java，P 表示 Python
NotExist	否	是	Bool	应用是否存在

GroupList

部署组列表信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
GroupId	是	否	String	部署组id
GroupName	是	否	String	部署组名

TsfPageSimpleGroupV2

TSF简单部署组分页列表

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总条数
Content	是	是	Array of SimpleGroup	简单部署组列表

ContainerGroupDetailV2

容器部署组详情

被如下接口引用：

名称	必选	允许NULL	类型	描述
GroupId	是	是	String	groupId
GroupName	是	是	String	分组名称
InstanceNum	是	是	Int64	实例总数
CurrentNum	是	是	Int64	已启动实例总数
CreateTime	是	是	String	创建时间
Server	是	是	String	镜像server
Reponame	是	是	String	镜像名，如/tsf/nginx
TagName	是	是	String	镜像版本名称
ClusterId	是	是	String	集群id
ClusterName	是	是	String	集群名称
NamespaceId	是	是	String	命名空间id
NamespaceName	是	是	String	命名空间名称
ApplicationId	是	是	String	应用id
LbIp	是	是	String	负载均衡ip
ApplicationType	是	是	String	应用类型
ClusterIp	是	是	String	Service ip
NodePort	是	是	Int64	NodePort端口，只有公网和NodePort访问方式才有值
CpuLimit	是	是	String	最大分配的 CPU 核数，对应 K8S limit
MemLimit	是	是	String	最大分配的内存 MiB 数，对应 K8S limit
AccessType	是	是	Uint64	0:公网 1:集群内访问 2：NodePort
UpdateType	是	是	Int64	更新方式：0:快速更新 1:滚动更新
UpdateIvl	是	是	Int64	更新间隔,单位秒
ProtocolPorts	是	是	Array of ProtocolPort	端口数组对象
Envs	是	是	Array of Env	环境变量数组对象
ApplicationName	是	是	String	应用名称
Message	是	是	String	pod错误信息描述
Status	是	是	String	部署组状态
MicroserviceType	是	是	String	服务类型
CpuRequest	是	是	String	初始分配的 CPU 核数，对应 K8S request
MemRequest	是	是	String	初始分配的内存 MiB 数，对应 K8S request
SubnetId	是	是	String	子网id

Ports

服务端口

被如下接口引用：CreateApplication、DescribeApplication、DescribeApplications、ModifyApplication

名称	必选	允许NULL	类型	描述
TargetPort	是	否	Uint64	服务端口
Protocol	是	否	String	端口协议

ZipkinMetadata

调用链Span元数据

被如下接口引用：GetTraceSpans

名称	必选	允许NULL	类型	描述
Value	是	是	String	元数据值
Timestamp	是	是	Uint64	元数据时间戳
Endpoint	是	是	ZipkinEndPoint	元数据端点信息

TsfPageGatewayPluginInstance

GatewayPluginInstance 翻页对象

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Uint64	记录总数
Content	是	否	Array of GatewayPluginInstance	记录实体列表

PackageConfig

程序包相关配置信息

被如下接口引用：DescribeResourceConfig

名称	必选	允许NULL	类型	描述
SpaceSize	是	是	Uint64	程序包存储空间大小，单位字节

TsfPageConfig

TsfPage<Config>

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

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	TsfPageConfig
Content	是	否	Array of Config	配置项列表

ExpandSubruleV2

ExpandSubrule

被如下接口引用：

名称	必选	允许NULL	类型	描述
Indicators	是	是	Int64	Indicators
IndicatorType	是	是	Int64	IndicatorType
RuleType	是	是	Int64	RuleType

CloudMonitorPolicies

云监控对象策略对象

被如下接口引用：ListColudMonitorStatisticsPolicy

名称	必选	允许NULL	类型	描述
KeywordsId	是	是	String	keywordsId
KeyWords	是	是	String	keyWords
GroupId	是	是	String	groupId
GroupName	是	是	String	groupName
NamespaceId	是	是	String	namespaceId
NamespaceName	是	是	String	namespaceName
ApplicationId	是	是	String	applicationId
ApplicationName	是	是	String	applicationName
ClusterId	是	是	String	clusterId
ClusterName	是	是	String	clusterName

TsfPageRecordV2

操作记录列表对象

被如下接口引用：DescribeRecords

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总数目
Content	是	是	Array of RecordV2	操作记录列表

ProgramItem

tsf-privilege模块，数据项

被如下接口引用：CreateProgram、DescribeProgram、DescribePrograms、ModifyProgram

名称	必选	允许NULL	类型	描述
ProgramItemId	否	是	String	数据项ID
Resource	否	是	Resource	资源
ValueList	否	是	Array of String	数据值列表
IsAll	否	是	Bool	全选标识，true: 全选；false: 非全选
CreationTime	否	是	Int64	创建时间
LastUpdateTime	否	是	Int64	最后更新时间
DeleteFlag	否	是	Bool	删除标识，true: 可删除；false: 不可删除
ProgramId	否	是	String	数据集ID

InstanceAdvancedSettings

容器导入实例高级设置

被如下接口引用：AddClusterInstances

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

ListApplicationServerResult

被如下接口引用：ListApplicationServers

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	TotalCount
Content	是	是	Array of ApplicationServerResult	Content

TsfPageRouteV2

路由分页列表

被如下接口引用：DescribeRoutes

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	服务路由总数目
Content	是	是	Array of RouteV2	服务路由详情列表

Resource

tsf-privilege 模块，资源

被如下接口引用：CreateProgram、DescribeProgram、DescribePrograms、DescribeResources、ModifyProgram

名称	必选	允许NULL	类型	描述
ResourceId	否	是	String	资源ID
ResourceCode	否	是	String	资源编码
ResourceName	否	是	String	资源名称
ServiceCode	否	是	String	资源所属产品编码
ResourceAction	否	是	String	选取资源使用的Action
IdField	否	是	String	资源数据查询的ID字段名
NameField	否	是	String	资源数据查询的名称字段名
SelectIdsField	否	是	String	资源数据查询的ID过滤字段名
CreationTime	否	是	Int64	创建时间
LastUpdateTime	否	是	Int64	最后更新时间
DeleteFlag	否	是	Bool	删除标识
ResourceDesc	否	是	String	资源描述
CanSelectAll	否	是	Bool	是否可以选择全部
SearchWordField	否	是	String	资源数据查询的模糊查询字段名
Index	否	是	Int64	排序

ResourceBatchOperationDescription

资源批次操作描述

被如下接口引用：DescribeResourceBatchOperation

名称	必选	允许NULL	类型	描述
EnableForcedStop	是	否	Bool	是否强制终止变更
EnableBeta	是	否	Bool	是否存在beta批次
BatchNum	是	否	Uint64	批次个数
BatchExeMode	是	否	String	批次执行方式
TaskType	是	否	Uint64	批次任务类型
GroupId	是	否	String	部署组ID
GroupName	是	否	String	部署组名称
CreateTime	是	否	String	创建时间

GroupUnitApiUseStatistics

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

被如下接口引用：DescribeUnitApiUseDetail

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	总记录数
Content	是	否	Array of UnitApiDailyUseStatistics	查询网关API监控明细对象集合

GatewayVo

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

被如下接口引用：DescribeGatewayAllGroupApis

名称	必选	允许NULL	类型	描述
GatewayDeployGroupId	是	是	String	网关部署组ID
GatewayDeployGroupName	是	是	String	网关部署组名称
GroupNum	是	是	Uint64	API 分组个数
Groups	是	是	Array of GatewayApiGroupVo	API 分组列表

VmGroupSimpleV2

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

被如下接口引用：

名称	必选	允许NULL	类型	描述
GroupId	是	是	String	部署组Id
GroupName	是	是	String	部署组名称
ApplicationType	是	是	String	应用类型
GroupDesc	是	是	String	部署组描述
UpdateTime	是	是	String	部署组更新时间
ClusterId	是	是	String	集群Id
StartupParameters	是	是	String	部署组启动参数
NamespaceId	是	是	String	命名空间Id
CreateTime	是	是	String	部署组创建时间
ClusterName	是	是	String	集群名称
ApplicationId	是	是	String	应用Id
ApplicationName	是	是	String	应用名称
NamespaceName	是	是	String	命名空间名称
MicroserviceType	是	是	String	应用微服务类型

TraceSpanDetail

span查询的出参

被如下接口引用：DescribeSpanDetail

名称	必选	允许NULL	类型	描述
TraceId	否	否	String	调用链traceid
SpanId	否	否	String	调用链spanid
ParentId	否	否	String	调用链parentid
Kind	否	否	String	调用链类型
Name	否	否	String	调用链name
Timestamp	否	否	Uint64	时间戳
Duration	否	否	Float	耗时
ResultStatus	否	否	String	状态
LocalComponent	否	否	String	组件
LocalEndpoint	否	否	ZipkinEndpointV2	local端点信息
RemoteEndpoint	否	否	ZipkinEndpointV2	remote端点信息
TagList	否	否	Array of SpanLabel	tags列表
GroupId	否	否	String	部署组id
GroupName	否	否	String	部署组名称
ClusterType	否	否	String	集群类型
NamespaceId	否	否	String	命名空间id
NamespaceName	否	否	String	命名空间名称
ResultCode	否	否	String	状态码
LaneId	否	否	String	泳道id
LaneName	否	否	String	泳道名称
CustomTagList	否	否	Array of SpanLabel	用户自定义metadata列表
ServiceName	否	否	String	服务名
ServiceId	否	否	String	服务Id

TsfPageBillingLicense

BillingLicense 翻页对象

被如下接口引用：DescribeAllBillingLicenses

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Uint64	记录总数
Content	是	是	Array of BillingLicense	记录实体列表

MetricDataCurve

指标监控数据曲线

被如下接口引用：DescribeInvocationMetricDataCurve、DescribeStatistics

名称	必选	允许NULL	类型	描述
MetricName	是	是	String	指标名称
MetricFunction	是	是	String	指标计算方式
MetricDataPoints	是	是	Array of MetricDataPoint	指标数据点集合

RatelimitListResult

none

被如下接口引用：DescribeRatelimit

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Uint64	总数
Content	是	是	Array of RatelimitRuleV2	列表内容

GraphEdge

依赖拓扑图边

被如下接口引用：

名称	必选	允许NULL	类型	描述
SourceName	是	是	String	来源服务名
TargetName	是	是	String	目标服务名
SourceType	是	是	String	来源服务类型
TargetType	是	是	String	目标服务类型
ReqTotalQty	是	是	Uint64	服务间总请求量
ReqSuccessQty	是	是	Uint64	服务间成功请求量
ReqFailedQty	是	是	Uint64	服务间失败请求量
ReqPerMin	是	是	Float	服务间每分钟平均请求量
AvgDurationMs	是	是	Float	服务间平均耗时（毫秒）

CloudMonitorPoliciesV2

云监控对象策略对象

被如下接口引用：

名称	必选	允许NULL	类型	描述
KeywordsId	是	是	String	keywordsId
KeyWords	是	是	String	keyWords
GroupId	是	是	String	groupId
GroupName	是	是	String	groupName
NamespaceId	是	是	String	namespaceId
NamespaceName	是	是	String	namespaceName
ApplicationId	是	是	String	applicationId
ApplicationName	是	是	String	applicationName
ClusterId	是	是	String	clusterId
ClusterName	是	是	String	clusterName

GroupDailyUseStatistics

分组日使用统计对象

被如下接口引用：DescribeGroupUseDetail

名称	必选	允许NULL	类型	描述
TopReqAmount	是	否	Array of GroupUseStatisticsEntity	总调用数
TopFailureRate	是	否	Array of GroupUseStatisticsEntity	平均错误率
TopAvgTimeCost	是	否	Array of GroupUseStatisticsEntity	平均响应耗时

RecordActionTypeNameV2

操作记录操作类型名称

被如下接口引用：

名称	必选	允许NULL	类型	描述
ActionType	是	是	String	操作记录操作类型
ActionTypeName	是	是	String	操作记录操作类型名称

DailyUseStatistics

日使用统计对象

被如下接口引用：DescribeGatewayDailyUseStatistics

名称	必选	允许NULL	类型	描述
TotalRequestCount	是	否	DailyUseStatisticsEntity	总调用数
AvgErrorRate	是	否	DailyUseStatisticsEntity	平均错误率
AvgResponseCost	是	否	DailyUseStatisticsEntity	平均响应耗时

DtsRetryResp

DTS重试主事务响应

被如下接口引用：RetryTransactions

名称	必选	允许NULL	类型	描述
ErrorList	是	是	Array of DtsRetryError	异常列表

OverviewConfig

概览页配置

被如下接口引用：DescribeResourceUsageConfig

名称	必选	允许NULL	类型	描述
ClusterThreshold	是	否	Uint64	集群显示阈值

GroupsByScalableRuleIdList

被如下接口引用：ListGroupsByScalableRuleId

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	TotalCount
Content	是	是	Array of GroupsByScalableRuleId	Content

MultipartPkg

分片包详情

被如下接口引用：DownloadMultipartPkg

名称	必选	允许NULL	类型	描述
PkgId	否	否	String	程序包ID
FileSeg	否	否	Uint64	当前分片 (从1开始)
FileSegments	否	是	Uint64	总分片数
SegmentSize	否	是	Uint64	每个分片的大小 (字节数)
Md5	否	是	String	文件的MD5
Size	否	是	Uint64	文件大小（总字节数）
File	否	是	String	文件编码数据 (@为首，表示base64编码)

WeightRouteItemList

权重路由规则项

被如下接口引用：CreateRouteRule、DescribeRouteReleaseHistory、DescribeRouteRule、DescribeRouteRules、ModifyRouteRule

名称	必选	允许NULL	类型	描述
WeightRouteId	否	否	String	权重路由规则项Id
SourcePercent	是	否	Int64	权重路由，百分比字段
TargetField	是	否	String	权重路由规则匹配目标字段
TargetValue	是	否	String	权重路由规则匹配目标取值
RouteRuleId	否	否	String	权重路由规则所属路由Id

TsfPageZipkinTraceInfoV2

调用链列表

被如下接口引用：SearchOssTrace、SearchTrace

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总条目数
Content	是	是	Array of ZipkinTraceInfoV2	调用链列表

ScalableTaskResult

被如下接口引用：ListScalableTasks

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	TotalCount
Content	是	是	Array of ScalableTask	Content

ImageRepositoryResult

镜像仓库列表

被如下接口引用：DescribeImageRepository

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总记录数
Server	是	是	String	镜像服务器地址
Content	是	是	Array of ImageRepository	列表信息

AlarmReceiverResult

被如下接口引用：DescribeAlarmPolicy、ListAlarmPolicies、ListAlarmReceivers

名称	必选	允许NULL	类型	描述
PolicyId	是	是	String	PolicyId
ReceiverId	是	是	String	ReceiverId
Name	是	是	String	Name
CellPhoneNumber	是	是	String	CellPhoneNumber
Email	是	是	String	Email

DeployGroupV2

部署组字段信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
GroupId	是	是	String	部署组Id
GroupName	是	是	String	部署组名称
ApplicationId	是	是	String	应用Id
ApplicationName	是	是	String	应用名称
ApplicationType	是	是	String	应用类型
ClusterId	是	是	String	集群Id
ClusterName	是	是	String	集群名称
NamespaceId	是	是	String	命名空间Id
NamespaceName	是	是	String	命名空间名称
GroupDesc	是	是	String	部署组描述
CreateTime	是	是	String	部署组创建时间
UpdateTime	是	是	String	部署组更新时间
InstanceCount	是	是	Int64	部署组实例数目
RunInstanceCount	是	是	Int64	部署组运行实例数目
OffInstanceCount	是	是	Int64	部署组停止实例数目
GroupStatus	是	是	String	部署组状态
StartupParameters	是	是	String	部署组启动参数
PackageId	是	是	String	部署组程序包Id
PackageName	是	是	String	部署组程序包名称
PackageVersion	是	是	String	部署组程序包版本
Server	是	是	String	镜像server
Reponame	是	是	String	镜像名，如/tsf/nginx
TagName	是	是	String	镜像版本名称
CpuLimit	是	是	String	最大分配cpu 核数，如0.6
MemLimit	是	是	String	最大分配内存M数
AccessType	是	是	Int64	0:公网 1:集群内访问 2：NodePort
UpdateType	是	是	Int64	更新方式：0:快速更新 1:滚动更新
UpdateIvl	是	是	Int64	更新间隔,单位秒
ProtocolPorts	是	是	Array of ProtocolPort	端口数组对象
InstanceNum	是	是	Int64	实例总数
CurrentNum	是	是	Int64	已启动实例总数
ClusterIp	是	是	String	Service ip
LbIp	是	是	String	负载均衡ip
Envs	是	是	Array of Env	环境变量数组对象
Message	是	是	String	pod错误信息描述
NodePort	是	是	Int64	NodePort端口，只有公网和NodePort访问方式才有值
Status	是	是	String	部署组状态
MicroserviceType	是	是	String	应用微服务类型

TxRetry

事务重试接口出参

被如下接口引用：AutoRetryTransaction、RetryTransaction

名称	必选	允许NULL	类型	描述
Success	是	是	Array of String	重试成功的事务ID列表
Missing	是	是	Array of String	重试失败的事务ID列表
Error	是	是	TxError	重试异常信息

DescribeContainerTasksResultV2

DescribeContainerTasksResult

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	列表总数
Content	是	是	Array of ContainerTasks	列表内容

BillingConfig

计费配置

被如下接口引用：DescribeBillingConfig

名称	必选	允许NULL	类型	描述
Enable	是	否	Bool	是否开启计费

TsfPageClusterV2

Tsf分页集群对象

被如下接口引用：DescribeClusters

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	集群总数目
Content	是	是	Array of ClusterV2	集群列表

DescribeTransactionResp

查询主事务详情

被如下接口引用：

名称	必选	允许NULL	类型	描述
Transaction	是	是	TxMainTransaction	主事务详情
Error	是	是	TxError	查询主事务异常信息

GroupResourceConfig

部署组相关的参数配置

被如下接口引用：DescribeResourceConfig

名称	必选	允许NULL	类型	描述
Container	是	是	ContainerGroupResourceConfig	容器部署组相关的参数配置

CosDownloadInfo

Cos下载所需信息

被如下接口引用：DescribeDownloadInfo、GetDownloadInfo

名称	必选	允许NULL	类型	描述
Bucket	是	是	String	桶名称
Region	是	是	String	地域
Path	是	是	String	路径
Credentials	是	是	CosCredentials	鉴权信息

ServerlessGroupPage

ServerlessGroup 翻页对象

被如下接口引用：DescribeServerlessGroups

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总记录数
Content	是	是	Array of ServerlessGroup	列表信息

ServiceStatisticsResults

服务统计结果集

被如下接口引用：DescribeStatistics

名称	必选	允许NULL	类型	描述
Content	是	是	Array of ServiceStatisticsResult	返回结果
TotalCount	是	是	Uint64	条数

DumpResult

被如下接口引用：GetDump

名称	必选	允许NULL	类型	描述
Name	否	是	String	Name
State	否	是	String	State
Detail	否	是	String	Detail

TagRouteItemSourceV2

标签路由规则项源标签

被如下接口引用：

名称	必选	允许NULL	类型	描述
TagRouteSourceId	否	否	String	标签路由规则项源标签ID
SourceType	是	否	String	标签路由，标签类型，表示系统标签或自定义标签, 系统标签： S, 自定义标签： U
SourceField	是	否	String	标签路由匹配源字段
SourceMatchRule	是	否	String	标签路由匹配源规则, 等于: EQUAL，不等于： NOT_EQUAL，包含： IN，不包含： NOT_IN，正则表达式： REGEX
SourceValue	是	否	String	标签路由匹配源取值
TagRouteItemId	否	否	String	标签路由规则项ID

AppPkgInfoV2

应用的包信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
ApplicationId	是	是	String	无
PkgCount	是	是	Int64	无

DescribeResourceConfigResultV2

DescribeResourceConfig

被如下接口引用：DescribeResourceConfig

名称	必选	允许NULL	类型	描述
Sts	是	是	DescribeResourceConfigSts	STS参数配置
License	是	是	DescribeResourceConfigLicense	许可信息
Group	是	是	GroupResourceConfig	部署组相关的参数配置
Instance	是	是	InstanceResourceConfig	实例相关的参数配置
Cluster	是	是	DescribeResourceConfigCluster	Cluster相关配置信息
Package	是	是	PackageConfig	程序包相关配置信息

DockerForUse

Docker使用指引

被如下接口引用：DescribeDockerForUse

名称	必选	允许NULL	类型	描述
Server	是	否	String	仓库中心地址
Username	是	否	String	用户名

MonitorStatisticsPolicyGroupV2

MonitorStatisticsPolicyGroup

被如下接口引用：

名称	必选	允许NULL	类型	描述
GroupId	是	是	String	GroupId
GroupName	是	是	String	GroupName
GroupDesc	是	是	String	GroupDesc
NamespaceId	是	是	String	NamespaceId
NamespaceName	是	是	String	NamespaceName
ApplicationId	是	是	String	ApplicationId
ApplicationName	是	是	String	ApplicationName
ClusterId	是	是	String	ClusterId
ClusterName	是	是	String	ClusterName

Result

FindMonitorObject返回的结果

被如下接口引用：FindMonitorObject、FindServiceMonitorObject

名称	必选	允许NULL	类型	描述
ObjName	是	否	String	KeyWordsName 和 GroupName

RouteRuleV2

路由规则项

被如下接口引用：CreateRoute、DescribeRoute、DescribeRoutes、ModifyRoute

名称	必选	允许NULL	类型	描述
RouteRuleId	否	是	String	路由规则项ID
TagList	否	是	Array of RouteTagV2	路由规则项包含TAG列表
DestList	是	否	Array of RouteDestV2	路由规则项包含目标列表
RouteId	否	是	String	路由规则项所属路由规则ID

Interface

描述接口信息

被如下接口引用：DescribeInstanceRequest

名称	必选	允许NULL	类型	描述
MicroserviceId	是	是	String	微服务id
Path	是	是	String	路径模版
Method	是	是	String	http请求方法

UnitApiDailyUseStatistics

被如下接口引用：DescribeUnitApiUseDetail

名称	必选	允许NULL	类型	描述
NamespaceId	是	是	String	NamespaceId
NamespaceName	是	是	String	NamespaceName
SumReqAmount	是	是	String	SumReqAmount
AvgFailureRate	是	是	String	AvgFailureRate
AvgTimeCost	是	是	String	AvgTimeCost
MetricDataPointMap	是	是	Array of MetricDataPointMap	MetricDataPointMap
TopStatusCode	是	是	Array of ApiDailyUseStatisticsEntity	TopStatusCode
TopTimeCost	是	是	Array of ApiDailyUseStatisticsEntity	TopTimeCost
Quantile	是	是	QuantileEntity	Quantile

DeleteImageTag

需要删除的镜像版本

被如下接口引用：DeleteImageTags

名称	必选	允许NULL	类型	描述
RepoName	是	否	String	仓库名，如/tsf/nginx
TagName	是	否	String	版本号:如V1

HealthCheckSetting

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

被如下接口引用：DeployContainerGroup、DeployGroup、DescribeContainerGroupAttribute、DescribeContainerGroupDeployInfo、DescribeContainerGroupDetail、DescribeGroup、UpdateHealthCheckSettings

名称	必选	允许NULL	类型	描述
ActionType	是	是	String	健康检查方法。HTTP：通过 HTTP 接口检查；CMD：通过执行命令检查；TCP：通过建立 TCP 连接检查。
InitialDelaySeconds	否	是	Uint64	容器延时启动健康检查的时间。
TimeoutSeconds	否	是	Uint64	每次健康检查响应的最大超时时间。
PeriodSeconds	否	是	Uint64	进行健康检查的时间间隔。
SuccessThreshold	否	是	Uint64	表示后端容器从失败到成功的连续健康检查成功次数。
FailureThreshold	否	是	Uint64	表示后端容器从成功到失败的连续健康检查成功次数。
Scheme	否	是	String	HTTP 健康检查方法使用的检查协议。支持HTTP、HTTPS。
Port	否	是	Uint64	健康检查端口，范围 1~65535 。
Path	否	是	String	HTTP 健康检查接口的请求路径。
Command	否	是	Array of String	执行命令检查方式，执行的命令。
Type	否	是	String	TSF_DEFAULT：tsf 默认就绪探针。K8S_NATIVE：k8s 原生探针。不填默认为 k8s 原生探针。

OperationInfoDetail

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

被如下接口引用：DescribeCluster、DescribeClusterInstanceCount、DescribeClusters、DescribeNamespaces、DescribeSimpleClusters、DescribeSimpleNamespaces

名称	必选	允许NULL	类型	描述
DisabledReason	是	是	String	不显示的原因
Enabled	是	是	Bool	该按钮是否可点击
Supported	是	是	Bool	是否显示该按钮

DescribeSingleContainerGroupsResult

被如下接口引用：DescribeSingleContainerGroups

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	列表数量
Content	是	是	Array of DescribeSingleContainerGroups	列表内容

MicroserviceExtraV2

微服务（信息更丰富版）

被如下接口引用：

名称	必选	允许NULL	类型	描述
MicroserviceId	否	是	String	微服务 ID
MicroserviceName	否	是	String	名称
MicroserviceDesc	否	是	String	描述
MicroserviceType	否	是	String	类型
AssociateApplicationId	否	是	String	关联的应用 ID
MicroserviceProtocol	否	是	String	协议
MicroserviceListeningPort	否	是	Int64	监听端口
HealthCheckUrl	否	是	String	健康检查参数
ServiceClustertype	否	是	String	集群类型
CreateTime	否	是	Int64	创建时间
UpdateTime	否	是	Int64	更新时间
NamespaceId	否	是	String	命名空间 ID
NamespaceName	否	是	String	命名空间名称
ClusterId	否	是	String	集群 ID
ClusterName	否	是	String	集群名称

MicroserviceExtra

微服务（信息更丰富版）

被如下接口引用：DescribeMicroservicesByAssociateApplication

名称	必选	允许NULL	类型	描述
MicroserviceId	否	是	String	微服务 ID
MicroserviceName	否	是	String	名称
MicroserviceDesc	否	是	String	描述
MicroserviceType	否	是	String	类型
AssociateApplicationId	否	是	String	关联的应用 ID
MicroserviceProtocol	否	是	String	协议
MicroserviceListeningPort	否	是	Int64	监听端口
HealthCheckUrl	否	是	String	健康检查参数
ServiceClustertype	否	是	String	集群类型
CreateTime	否	是	Int64	创建时间
UpdateTime	否	是	Int64	更新时间
NamespaceId	否	是	String	命名空间 ID
NamespaceName	否	是	String	命名空间名称
ClusterId	否	是	String	集群 ID
ClusterName	否	是	String	集群名称

DtsGroupStatistics

事务分组统计信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
GroupId	是	是	String	事务分组ID
TxQty	是	是	Int64	主事务总数
BranchQty	是	是	Int64	分支事务总数
ErrorTxQty	是	是	Int64	异常主事务数

TsfPageAuthorization

虽然挂着 TsfPage，但是它没有继承 TsfPage 类（后面可能会）。这是个全量接口。

被如下接口引用：DescribeAuthorizationInfo

名称	必选	允许NULL	类型	描述
IsEnabled	是	否	Bool	鉴权规则是否被启用
Conditions	是	是	Array of AuthCondition	鉴权规则列表

JavaFlameGraph

DescribeFlameGraph接口返回火焰图数据封装

被如下接口引用：DescribeFlameGraph

名称	必选	允许NULL	类型	描述
FlameGraphData	是	是	String	火焰图Json,历史无采集成功的火焰图返回""
CreationTime	是	是	String	火焰图创建时间,格式为(yyyy-MM-dd HH:mm:ss),历史无采集成功的火焰图返回""
Duration	是	是	Int64	火焰图采集时长,历史无采集成功的火焰图返回0
Status	是	是	String	调用成功success/调用失败error
StatusInfo	是	是	String	调用成功为""/调用失败为对应失败信息
StatusCode	是	是	Int64	调用成功为0/调用失败为对应的错误码
Event	是	是	String	采集类型

ConfigReleaseLog

配置项发布日志

被如下接口引用：DescribeConfigReleaseLogs、DescribePublicConfigReleaseLogs

名称	必选	允许NULL	类型	描述
ConfigReleaseLogId	是	是	String	配置项发布日志ID
ConfigId	是	是	String	配置项ID
ConfigName	是	是	String	配置项名称
ConfigVersion	是	是	String	配置项版本
GroupId	是	是	String	部署组ID
GroupName	是	是	String	部署组名称
NamespaceId	是	是	String	命名空间ID
NamespaceName	是	是	String	命名空间名称
ClusterId	是	是	String	集群ID
ClusterName	是	是	String	集群名称
ReleaseTime	是	是	String	发布时间
ReleaseDesc	是	是	String	发布描述
ReleaseStatus	是	是	String	发布状态
LastConfigId	是	是	String	上次发布的配置项ID
LastConfigName	是	是	String	上次发布的配置项名称
LastConfigVersion	是	是	String	上次发布的配置项版本
RollbackFlag	是	是	Bool	回滚标识

ConfigSummary

配置项统计信息，其实就是Config的部分字段

被如下接口引用：

名称	必选	允许NULL	类型	描述
ConfigName	是	否	String	配置项名称
ConfigVersionCount	是	否	Int64	配置项值
LastUpdateTime	是	否	String	配置项类型
ApplicationId	是	否	String	应用ID
ApplicationName	是	否	String	应用名称

SidecarFilterGroup

过滤器关联的部署组

被如下接口引用：DescribeSidecarFilter、DescribeSidecarFilters、ReleaseSidecarFilter

名称	必选	允许NULL	类型	描述
GroupId	是	否	String	部署组Id
FilterId	是	否	String	过滤器Id
GroupName	是	是	String	部署组名称
NamespaceId	是	否	String	部署组所在命名空间Id
NamespaceName	是	是	String	部署组所在名称空间名称

TsfPageSimpleGroup

TSF简单部署组分页列表

被如下接口引用：DescribeSimpleGroups

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总条数
Content	是	是	Array of SimpleGroup	简单部署组列表

ModuleParameterResult

被如下接口引用：SaveDeployModuleParams

名称	必选	允许NULL	类型	描述
ParameterConfigType	否	否	String	ParameterConfigType
ParameterSubType	否	否	String	ParameterSubType
ParameterName	否	否	String	ParameterName
ParameterValue	否	否	String	ParameterValue

TaskExecuteHistoryRecord

任务执行记录的流水列表

被如下接口引用：DescribeTaskExecuteHistoryRecords

名称	必选	允许NULL	类型	描述
ExecuteLogId	是	否	String	执行流水ID
ExecuteId	是	否	String	执行ID
GroupId	是	是	String	任务执行分组
InstanceId	是	否	String	实例ID
State	是	否	String	实例执行状态
TriggerType	是	否	String	触发方式
StartTime	是	否	Int64	开始时间
EndTime	是	是	Int64	结束时间
TimeOut	是	是	Int64	超时时间
ExecuteLog	是	是	String	执行日志
HistoryCount	是	是	Int64	历史执行次数
ShardKey	是	是	Uint64	分片Key

GatewayApiGroupVo

网关分组简单信息

被如下接口引用：DescribeGatewayAllGroupApis

名称	必选	允许NULL	类型	描述
GroupId	是	是	String	分组ID
GroupName	是	是	String	分组名称
GroupApiCount	是	是	Uint64	分组下API个数
GroupApis	是	是	Array of GatewayGroupApiVo	分组API列表

BusinessLogConfigSchema

业务日志配置解析规则

被如下接口引用：CreateBusinessLogConfig、DescribeBusinessLogConfig、DescribeBusinessLogConfigs、DescribeGroupBusinessLogConfigs、UpdateBusinessLogConfig

名称	必选	允许NULL	类型	描述
SchemaType	是	否	Int64	解析规则类型
SchemaContent	否	是	String	解析规则内容
SchemaDateFormat	否	是	String	解析规则时间格式
SchemaMultilinePattern	否	是	String	解析规则对应的多行匹配规则
SchemaCreateTime	否	是	String	解析规则创建时间
SchemaPatternLayout	否	是	String	用户填写的解析规则

GatewayPlugin

微服务网关插件实例对象

被如下接口引用：DescribeGatewayPlugins、DescribePluginInstances

名称	必选	允许NULL	类型	描述
Id	是	是	String	网关插件id
Name	是	是	String	插件名称
Type	是	是	String	插件类型
Description	是	是	String	插件描述
CreatedTime	是	是	String	创建时间
UpdatedTime	是	是	String	更新时间
Status	是	是	String	发布状态

ImageTag

列表信息

被如下接口引用：DescribeImageTags

名称	必选	允许NULL	类型	描述
RepoName	是	否	String	仓库名
TagName	是	否	String	版本名称
TagId	是	否	String	版本ID
ImageId	是	否	String	镜像ID
Size	是	否	String	大小
CreationTime	是	否	String	创建时间
UpdateTime	是	否	String	更新时间
Author	是	否	String	镜像制作者
Architecture	是	否	String	CPU架构
DockerVersion	是	否	String	Docker客户端版本
Os	是	是	String	操作系统
PushTime	是	否	String	push时间
SizeByte	是	否	Int64	单位为字节

BillingOperationRecord

计费操作记录

被如下接口引用：DescribeBillingOperationRecords

名称	必选	允许NULL	类型	描述
ResourceId	是	是	String	资源ID
CategoryId	是	是	Int64	类别ID
CreateTime	是	是	String	创建时间
AppId	是	是	String	租户ID
Uin	是	是	String	账号ID
Nickname	是	是	String	用户昵称
Operator	是	是	String	操作人
Description	是	是	String	描述
OperationDetail	是	是	String	操作详情

TsfPageApplication

应用分页信息

被如下接口引用：DescribeApplications

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	应用总数目
Content	是	是	Array of ApplicationForPage	应用信息列表

MsApplication

应用

被如下接口引用：

名称	必选	允许NULL	类型	描述
ApplicationId	否	是	String	应用 ID，如 application-qv3dkda7
ApplicationName	否	是	String	应用名
ApplicationDesc	否	是	String	应用描述
ApplicationType	否	是	String	应用部署类型，V 表示 CVM 应用，C 表示容器应用
ApplicationJvmArg	否	是	String	应用启动时的 JVM 参数
MicroserviceType	否	是	String	应用类型，M 表示 Mesh 应用，N 表示 Spring Cloud 应用
ProgLang	否	是	String	应用编程语言，J 表示 Java，P 表示 Python
NotExist	否	是	Bool	应用是否存在

TaskRuleCheckResult

任务触发规则检查结果

被如下接口引用：CheckTaskRule

名称	必选	允许NULL	类型	描述
Success	是	否	Bool	是否校验成功
Msg	否	是	String	校验结果信息
NextFireTimes	否	是	Array of Uint64	预计下三次触发时间点

ContainerGroupV2

部署组

被如下接口引用：

名称	必选	允许NULL	类型	描述
GroupId	否	否	String	groupId
GroupName	否	否	String	分组名称
CreateTime	否	否	String	创建时间
Server	是	否	String	镜像server
Reponame	是	否	String	镜像名，如/tsf/nginx
TagName	是	否	String	镜像版本名称
ClusterId	是	否	String	集群id
ClusterName	是	否	String	集群名称
NamespaceId	是	否	String	命名空间id
NamespaceName	是	否	String	命名空间名称
ApplicationId	是	否	String	应用名称
ApplicationName	是	否	String	应用类型
ApplicationType	是	否	String	分组创建时间
UpdateTime	是	否	String	分组更新时间
MicroserviceType	是	是	String	微服务类型

RouteTagV2

服务路由规则项匹配条件

被如下接口引用：CreateRoute、DescribeRoute、DescribeRoutes、ModifyRoute

名称	必选	允许NULL	类型	描述
TagId	否	是	String	路由规则项TAG匹配项ID
TagType	是	否	String	标签类型，S：系统标签， U：自定义标签
TagField	是	否	String	标签字段名称
TagOperator	是	否	String	标签匹配规则.EQUAL：等于、NOT_EQUAL：不等于、IN：包含、NOT_IN：不包含、REGEX：正则
TagValue	是	否	String	标签取值
RouteRuleId	否	是	String	TAG匹配项所述路由规则项ID

TsfPageRecordActionTypeNameV2

操作记录操作类型名称列表

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总数目
Content	是	是	Array of RecordActionTypeNameV2	操作类型名称列表

GroupUseStatisticsEntity

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

被如下接口引用：DescribeGroupUseDetail

名称	必选	允许NULL	类型	描述
ApiPath	是	是	String	API 路径
ServiceName	是	是	String	服务名
Value	是	是	String	统计值
ApiId	是	是	String	API ID

ProjectListV2

ProjectList

被如下接口引用：

名称	必选	允许NULL	类型	描述
ProjectId	是	否	String	工程id
ProjectName	是	否	String	工程名
BasePackage	是	否	String	包路径
LastTime	是	否	Int64	修改时间
AppId	否	否	String	AppId
Uin	否	否	String	Uin
SubAccountUin	否	否	String	SubAccountUin
Data	否	否	String	Data

DescribeTemplateResultV2

DescribeTemplateResult

被如下接口引用：

名称	必选	允许NULL	类型	描述
ProjectId	是	否	String	ProjectId
ProjectName	是	否	String	ProjectName
BasePackage	是	否	String	BasePackage
PomGroupId	是	否	String	PomGroupId
PomArtifactId	是	否	String	PomArtifactId
PomVersion	是	否	String	PomVersion
PomName	是	否	String	PomName
PomDesc	是	否	String	PomDesc
GetMethod	是	否	String	GetMethod
Ms	是	否	Array of Ms	Ms
Action	否	否	String	action
AppId	否	否	String	appId
Uin	否	否	String	Uin
SubAccountUin	否	否	String	SubAccountUin

DescribeResourceConfigResult

DescribeResourceConfig

被如下接口引用：

名称	必选	允许NULL	类型	描述
Sts	是	是	DescribeResourceConfigSts	Sts
License	是	是	DescribeResourceConfigLicense	License

TsfPageGatewayInstance

网关实体分页信息

被如下接口引用：DescribeGatewayInstances

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	数据总数
Content	是	是	Array of GatewayInstance	翻页数据

DescribeSubTransactionResp

查询子事务列表

被如下接口引用：

名称	必选	允许NULL	类型	描述
Content	是	是	Array of SubTransaction	子事务列表
TotalCount	是	是	Int64	子事务个数
Error	是	是	TxError	错误信息

GatewayPluginBoundParam

微服务网关插件绑定对象

被如下接口引用：BindPlugin、UnbindPlugin

名称	必选	允许NULL	类型	描述
PluginId	是	否	String	插件id
ScopeType	是	否	String	插件绑定到的对象类型:group/api
ScopeValue	是	否	String	插件绑定到的对象主键值，例如分组的ID/API的ID

ListScalableRuleResult

被如下接口引用：ListScalableRule

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	TotalCount
Content	是	是	Array of ScalableRule	Content

TsfPrice

Tsf 询价返回

被如下接口引用：DescribePrice

名称	必选	允许NULL	类型	描述
TotalCost	是	否	Int64	总费用，不包含优惠，单位：分
RealTotalCost	是	否	Int64	优惠后总价, 单位: 分
Label	是	否	String	计费项标签 key
TimeSpan	是	否	Int64	计费项标签值，也是询价月份信息

ImageFeature

镜像特征

被如下接口引用：DescribeImageFeatures

名称	必选	允许NULL	类型	描述
FeatureId	是	是	String	特征ID
FeatureType	是	是	String	特征类型
Name	是	是	String	名称
Version	是	是	String	版本

CloudMonitorMicroservice

被如下接口引用：DescribeMicroServiceList、ListCloudMicroServiceFindPagedList

名称	必选	允许NULL	类型	描述
NamespaceId	否	否	String	namespaceId
NamespaceName	否	否	String	namespaceName
MicroserviceId	否	否	String	microserviceId
MicroserviceName	否	否	String	microserviceName

GatewayOAuthPlugin

被如下接口引用：DescribeGatewayOAuthPlugin

名称	必选	允许NULL	类型	描述
Id	是	否	String	网关插件id
Name	是	是	String	插件名称
Description	是	是	String	插件描述
Type	是	是	String	插件类型
CreatedTime	是	是	String	插件创建时间如:2019-06-20 15:51:28
UpdatedTime	是	是	String	插件更新时间如:2019-06-20 15:51:28
TokenAuthUrl	是	是	String	验证token路径
TokenAuthMethod	是	是	String	验证token请求方法:get/post
ExpireTime	是	是	Int64	认证请求超时时间,单位:秒范围:0~30
RedirectUrl	是	是	String	重定向地址
TokenBaggagePosition	是	是	String	token携带位置，网关取token位置与发送认证请求时token位置一致,值:query/header
TokenKeyName	是	是	String	token的key值
PayloadMappingName	是	是	String	payload的映射参数名称
PayloadMappingPosition	是	是	String	payload映射到后端服务的携带位置,值:query/header
Status	是	是	String	发布状态: drafted/released

ContainerTasksResult

变更记录任务列表

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	总记录数
Content	是	否	Array of ContainerTasks	列表信息

PagedRole

tsf-privilege 模块分页的Role列表

被如下接口引用：DescribeRoles

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	总条数
Content	是	否	Array of Role	角色列表

Provider

provider

被如下接口引用：CreateAndDownloadTemplate、CreateTemplate

名称	必选	允许NULL	类型	描述
ProviderControllerName	是	是	String	ProviderControllerName

DailyUseStatisticsEntity

日统计数据节点

被如下接口引用：DescribeGatewayDailyUseStatistics

名称	必选	允许NULL	类型	描述
Value	是	是	String	日统计值
DailyRate	是	是	String	日环比值
WeekRate	是	是	String	周同比值

StatisticsEntry

概览页统计列表条目

被如下接口引用：GetTopAvgTimeCostInterfaces、GetTopAvgTimeCostServices、GetTopFailureRateInterfaces、GetTopFailureRateServices、GetTopReqAmountInterfaces、GetTopReqAmountServices

名称	必选	允许NULL	类型	描述
PrimeKey	是	是	String	主字段
SubKey	是	是	String	附字段
Value	是	是	String	值

Env

环境变量

被如下接口引用：DeployContainerGroup、DescribeContainerGroupAttribute、DescribeContainerGroupDeployInfo、DescribeContainerGroupDetail、DescribeDeployGroup、FindContainerGroup

名称	必选	允许NULL	类型	描述
Name	是	否	String	环境变量名称
Value	是	否	String	环境变量值

JvmLockDetail

Jvm检测死锁返回死锁详情封装

被如下接口引用：RunJvmDeadLockCheck

名称	必选	允许NULL	类型	描述
ThreadCount	是	是	Int64	死锁线程数, 没有死锁时为0
LockInfos	是	是	String	死锁检测响应信息,没有死锁时为空串""
Status	是	是	String	调用成功success/调用失败error
StatusInfo	是	是	String	调用成功为""/调用失败为对应失败信息
StatusCode	是	是	Int64	调用成功为0/调用失败为对应的错误码

TsfPageMsInstanceWrong

微服务实例的分页内容

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总数目
Content	是	是	Array of MsInstanceWrong	微服务实例列表内容
MicroserviceType	是	是	String	微服务类型

Controller

tsf模板

被如下接口引用：CreateAndDownloadTemplate、CreateTemplate

名称	必选	允许NULL	类型	描述
ControllerName	是	是	String	ControllerName

DeployGroup

部署组字段信息

被如下接口引用：DescribeDeployGroup

名称	必选	允许NULL	类型	描述
GroupId	是	是	String	部署组Id
GroupName	是	是	String	部署组名称
ApplicationId	是	是	String	应用Id
ApplicationName	是	是	String	应用名称
ApplicationType	是	是	String	应用类型
ClusterId	是	是	String	集群Id
ClusterName	是	是	String	集群名称
NamespaceId	是	是	String	命名空间Id
NamespaceName	是	是	String	命名空间名称
GroupDesc	是	是	String	部署组描述
CreateTime	是	是	String	部署组创建时间
UpdateTime	是	是	String	部署组更新时间
InstanceCount	是	是	Int64	部署组实例数目
RunInstanceCount	是	是	Int64	部署组运行实例数目
OffInstanceCount	是	是	Int64	部署组停止实例数目
GroupStatus	是	是	String	部署组状态
StartupParameters	是	是	String	部署组启动参数
PackageId	是	是	String	部署组程序包Id
PackageName	是	是	String	部署组程序包名称
PackageVersion	是	是	String	部署组程序包版本
Server	是	是	String	镜像server
Reponame	是	是	String	镜像名，如/tsf/nginx
TagName	是	是	String	镜像版本名称
CpuLimit	是	是	String	最大分配cpu 核数，如0.6
MemLimit	是	是	String	最大分配内存M数
AccessType	是	是	Int64	0:公网 1:集群内访问 2：NodePort
UpdateType	是	是	Int64	更新方式：0:快速更新 1:滚动更新
UpdateIvl	是	是	Int64	更新间隔,单位秒
ProtocolPorts	是	是	Array of ProtocolPort	端口数组对象
InstanceNum	是	是	Int64	实例总数
CurrentNum	是	是	Int64	已启动实例总数
ClusterIp	是	是	String	Service ip
LbIp	是	是	String	负载均衡ip
Envs	是	是	Array of Env	环境变量数组对象
Message	是	是	String	pod错误信息描述
NodePort	是	是	Int64	NodePort端口，只有公网和NodePort访问方式才有值
Status	是	是	String	部署组状态
MicroserviceType	是	是	String	应用微服务类型

TsfPageMsInstance

微服务实例的分页内容

被如下接口引用：DescribeMicroservice

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	微服务实例总数目
Content	是	是	Array of MsInstance	微服务实例列表内容

GetClusterLimitResourceResult

获取集群limit资源(GetClusterLimitResource)返回对象

被如下接口引用：GetClusterLimitResource

名称	必选	允许NULL	类型	描述
CpuLimit	是	否	String	最大分配cpu 核数
MemLimit	是	否	String	最大分配mem内存数，单位M

JvmMonitorData

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

被如下接口引用：DescribeJvmMonitor

名称	必选	允许NULL	类型	描述
HeapMemory	是	是	MemoryPicture	堆内存监控图,三条线
NonHeapMemory	是	是	MemoryPicture	非堆内存监控图,三条线
EdenSpace	是	是	MemoryPicture	伊甸园区监控图,三条线
SurvivorSpace	是	是	MemoryPicture	幸存者区监控图,三条线
OldSpace	是	是	MemoryPicture	老年代监控图,三条线
MetaSpace	是	是	MemoryPicture	元空间监控图,三条线
ThreadPicture	是	是	ThreadPicture	线程监控图,三条线
YoungGC	是	是	Array of CurvePoint	youngGC增量监控图,一条线
FullGC	是	是	Array of CurvePoint	fullGC增量监控图,一条线
CpuUsage	是	是	Array of CurvePoint	cpu使用率,一条线
ClassCount	是	是	Array of CurvePoint	加载类数,一条线

PkgList

包列表

被如下接口引用：DescribePkgs、ListPkg

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	程序包总量
Content	是	是	Array of PkgInfo	程序包信息列表
RepositoryId	是	是	String	程序包仓库id
RepositoryType	是	是	String	程序包仓库类型
RepositoryName	是	是	String	程序包仓库名称

Metric

指标

被如下接口引用：DescribeInvocationMetricDataCurve

名称	必选	允许NULL	类型	描述
Name	否	是	String	指标名称
Function	否	是	String	指标计算方式

TaskFlow

工作流对象

被如下接口引用：DescribeTaskFlows

名称	必选	允许NULL	类型	描述
FlowId	是	否	String	工作流Id
FlowName	是	否	String	工作流名称
State	是	是	String	状态
TaskCount	是	是	Int64	任务数量
TriggerRule	是	否	TaskRule	触发规则
TimeOut	是	是	Int64	工作流超时时间
FlowLogId	是	否	String	工作流历史 ID
GraphId	是	是	String	工作流图 ID

GraphNode

依赖拓扑图节点

被如下接口引用：

名称	必选	允许NULL	类型	描述
Name	是	是	String	节点服务名
Type	是	是	String	节点服务类型
ReqTotalQty	是	是	Uint64	节点服务总请求量
ReqSuccessQty	是	是	Uint64	节点服务成功请求量
ReqFailedQty	是	是	Uint64	节点服务失败请求量
ReqPerMin	是	是	Float	节点服务每分钟平均请求量
AvgDurationMs	是	是	Float	节点服务平均耗时（毫秒）
EdgeList	是	是	Array of GraphEdge	节点服务为目的的边列表（入度）

ContainerGroupResultV2

镜像版本列表

被如下接口引用：

名称	必选	允许NULL	类型	描述
Content	是	是	Array of ContainerGroup	镜像版本列表
TotalCount	是	是	Int64	总记录数

ListAlarmPoliciesResult

被如下接口引用：ListAlarmPolicies

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	TotalCount
Content	是	是	Array of AlarmPolicyResult	Content

PagedDtsTransaction

DTS主事务分页对象

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总条数，特定在该接口中总是会返回null
Content	是	是	Array of DtsTransaction	主事务分组列表

ControllerV2

tsf模板

被如下接口引用：

名称	必选	允许NULL	类型	描述
ControllerName	是	是	String	ControllerName

DescribeResourceConfigLicenseFunction

DescribeResourceConfig

被如下接口引用：DescribeResourceConfig

名称	必选	允许NULL	类型	描述
Name	是	是	String	name
Enable	是	是	Bool	enable

PathRewrite

路径重写

被如下接口引用：DescribePathRewrite、DescribePathRewrites

名称	必选	允许NULL	类型	描述
PathRewriteId	是	否	String	路径重写规则ID
GatewayGroupId	是	否	String	网关部署组ID
Regex	是	否	String	正则表达式
Replacement	是	否	String	替换的内容
Blocked	是	否	String	是否屏蔽映射后路径，Y: 是 N: 否
Order	是	否	Int64	规则顺序，越小优先级越高

InstanceRequest

单条实例请求详情

被如下接口引用：DescribeInstanceRequest

名称	必选	允许NULL	类型	描述
TraceId	是	是	String	trace id
Timestamp	是	是	Int64	产生时间
Duration	是	是	Int64	耗时
ResultStatus	是	是	String	状态
ResultError	是	是	String	错误
InterfaceInfo	是	是	Interface	接口信息

PagedProgram

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

被如下接口引用：DescribePrograms

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	总条数
Content	是	否	Array of Program	数据集列表

GraphEdgeV2

依赖拓扑图边

被如下接口引用：GetOssTopologyGraph、GetTopologyGraph

名称	必选	允许NULL	类型	描述
SourceName	是	是	String	来源服务名
TargetName	是	是	String	目标服务名
SourceType	是	是	String	来源服务类型
TargetType	是	是	String	目标服务类型
ReqTotalQty	是	是	Uint64	服务间总请求量
ReqAvgQty	是	是	Float	请求平均数，次每分钟，两位小数
ReqSuccessRate	是	是	Float	请求成功率，两位小数
ReqAvgDuration	是	是	Float	请求平均耗时，单位毫秒，两位小数
Apdex	是	是	Float	健康度指标
SourceId	是	是	String	来源节点标识
TargetId	是	是	String	目标节点标识
SourceNamespaceId	是	是	String	来源命名空间ID
TargetNamespaceId	是	是	String	目标命名空间ID

ScalableRuleAttribute

被如下接口引用：DescribeScalableRuleAttribute

名称	必选	允许NULL	类型	描述
RuleId	是	是	String	RuleId
Name	是	是	String	Name
EnableShrink	是	是	Int64	EnableShrink
EnableExpand	是	是	Int64	EnableExpand
ExpandPeriod	是	是	Int64	ExpandPeriod
ShrinkPeriod	是	是	Int64	ShrinkPeriod
ExpandVmCount	是	是	Int64	ExpandVmCount
ShrinkVmCount	是	是	Int64	ShrinkVmCount
CoolTime	是	是	Int64	CoolTime
ExpandVmCountLimit	是	是	Int64	ExpandVmCountLimit
ShrinkVmCountLimit	是	是	Int64	ShrinkVmCountLimit
ExpandSubruleList	是	是	Array of ExpandSubrule	ExpandSubruleList
ShrinkSubruleList	是	是	Array of ExpandSubrule	ShrinkSubruleList
CreateTime	是	是	String	CreateTime
UpdateTime	是	是	String	UpdateTime

LicenseTag

许可标签

被如下接口引用：DescribeLicenses

名称	必选	允许NULL	类型	描述
LicenseId	是	是	String	许可ID
Tags	是	是	Array of Tag	标签列表

MemoryPicture

Jvm监控内存数据封装

被如下接口引用：DescribeJvmMonitor

名称	必选	允许NULL	类型	描述
Max	是	否	Array of CurvePoint	内存最大值
Used	是	否	Array of CurvePoint	已用内存大小
Committed	是	否	Array of CurvePoint	系统分配内存大小

TsfPageStdoutLogV2

标准输出日志列表

被如下接口引用：SearchOssRealtimeBusinessLog、SearchRealtimeBusinessLog、SearchRealtimeMeshLog、SearchRealtimeStdoutLog、SearchStdoutLog

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总条数
Content	是	是	Array of StdoutLogV2	标准输出日志列表
ScrollId	是	是	String	游标ID
Status	是	是	String	查询状态

PagedProductHelp

产品帮助分组分页对象

被如下接口引用：DescribeProductHelp

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总条数
Content	是	是	Array of ProductHelp	产品帮助列表

TsfPageSimpleCluster

TSF分页简单集群

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总条数
Content	是	是	Array of SimpleCluster	简单集群列表

ContainerGroup

部署组

被如下接口引用：

名称	必选	允许NULL	类型	描述
GroupId	否	否	String	部署组ID
GroupName	否	否	String	分组名称
CreateTime	否	否	String	创建时间
Server	是	否	String	镜像server
Reponame	是	否	String	镜像名，如/tsf/nginx
TagName	是	否	String	镜像版本名称
ClusterId	是	否	String	集群ID
ClusterName	是	否	String	集群名称
NamespaceId	是	否	String	命名空间ID
NamespaceName	是	否	String	命名空间名称
ApplicationId	是	否	String	应用名称
ApplicationName	是	否	String	应用类型
ApplicationType	是	否	String	分组创建时间
UpdateTime	是	否	String	分组更新时间
MicroserviceType	是	是	String	微服务类型

LicenseResource

被如下接口引用：DescribeLicenseApplications

名称	必选	允许NULL	类型	描述
Name	是	否	String	资源名
Quota	是	否	Uint64	配额

Program

tsf-privilege模块 Program数据集

被如下接口引用：DescribeProgram、DescribePrograms

名称	必选	允许NULL	类型	描述
ProgramId	否	是	String	数据集ID
ProgramName	否	是	String	数据集名称
ProgramDesc	否	是	String	数据集描述
DeleteFlag	否	是	Bool	删除标识，true: 可以删除; false: 不可删除
CreationTime	否	是	Int64	创建时间
LastUpdateTime	否	是	Int64	最后更新时间
ProgramItemList	否	是	Array of ProgramItem	数据项列表，无值时返回空数组

Service

tsf-privilege模块，产品

被如下接口引用：DescribeServices

名称	必选	允许NULL	类型	描述
ServiceId	否	是	String	产品ID
ServiceCode	否	是	String	产品编码
ServiceName	否	是	String	产品名称
CreationTime	否	是	Int64	创建时间
LastUpdateTime	否	是	Int64	更新时间
DeleteFlag	否	是	Bool	删除标识，true: 可以删除；false: 不可删除

VmGroup

虚拟机部署组信息

被如下接口引用：DescribeGroup

名称	必选	允许NULL	类型	描述
GroupId	是	是	String	部署组ID
GroupName	是	是	String	部署组名称
GroupStatus	是	是	String	部署组状态
PackageId	是	是	String	程序包ID
PackageName	是	是	String	程序包名称
PackageVersion	是	是	String	程序包版本号
ClusterId	是	是	String	集群ID
ClusterName	是	是	String	集群名称
NamespaceId	是	是	String	命名空间ID
NamespaceName	是	是	String	命名空间名称
ApplicationId	是	是	String	应用ID
ApplicationName	是	是	String	应用名称
InstanceCount	是	是	Int64	部署组机器数目
RunInstanceCount	是	是	Int64	部署组运行中机器数目
StartupParameters	是	是	String	部署组启动参数信息
CreateTime	是	是	String	部署组创建时间
UpdateTime	是	是	String	部署组更新时间
OffInstanceCount	是	是	Int64	部署组停止机器数目
GroupDesc	是	是	String	部署组描述信息
MicroserviceType	是	是	String	微服务类型
ApplicationType	是	是	String	应用类型
GroupResourceType	是	是	String	部署组资源类型
UpdatedTime	是	是	Int64	部署组更新时间戳
DeployDesc	是	是	String	部署应用描述信息
UpdateType	是	是	Uint64	滚动发布的更新方式
DeployBetaEnable	是	是	Bool	发布是否启用beta批次
DeployBatch	是	是	Array of Float	滚动发布的批次比例列表
DeployExeMode	是	是	String	滚动发布的批次执行方式
DeployWaitTime	是	是	Uint64	滚动发布的每个批次的等待时间
EnableHealthCheck	是	是	Bool	是否开启了健康检查
HealthCheckSettings	是	是	HealthCheckSettings	健康检查配置
PackageType	是	是	String	程序包类型
StartScript	是	是	String	启动脚本 base64编码
StopScript	是	是	String	停止脚本 base64编码

VmGroupOther

虚拟机部署组其他字段

被如下接口引用：DescribeGroupAttribute、DescribeGroupOther

名称	必选	允许NULL	类型	描述
GroupId	是	是	String	部署组ID
PackageId	是	是	String	程序包ID
PackageName	是	是	String	程序包名称
PackageVersion	是	是	String	程序包版本
InstanceCount	是	是	Int64	部署组实例数
RunInstanceCount	是	是	Int64	部署组运行中实例数
OffInstanceCount	是	是	Int64	部署组中停止实例数
GroupStatus	是	是	String	部署组状态
IsNotEqualServiceConfig	是	是	Bool	服务配置信息是否匹配

ContainerGroupResult

镜像版本列表

被如下接口引用：

名称	必选	允许NULL	类型	描述
Content	是	是	Array of ContainerGroup	镜像版本列表
TotalCount	是	是	Int64	总记录数

SimpleGroup

部署组

被如下接口引用：DescribeSimpleGroups

名称	必选	允许NULL	类型	描述
GroupId	是	是	String	部署组ID
GroupName	是	是	String	部署组名称
ApplicationId	是	是	String	应用ID
ApplicationName	是	是	String	应用名称
ApplicationType	是	是	String	应用类型
ClusterId	是	是	String	集群ID
ClusterName	是	是	String	集群名称
ClusterType	是	是	String	集群类型
NamespaceId	是	是	String	命名空间ID
NamespaceName	是	是	String	命名空间名称
StartupParameters	是	是	String	启动参数
GroupResourceType	是	是	String	部署组资源类型
AppMicroServiceType	是	是	String	应用微服务类型

ListTsfRegionResult

被如下接口引用：DescribeRegions

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	TotalCount
Content	是	是	Array of TsfRegionResult	Content

ClusterLimitResource

集群limit资源

被如下接口引用：

名称	必选	允许NULL	类型	描述
CpuLimit	是	否	String	最大分配cpu 核数
MemLimit	是	否	String	最大分配内存M数

SidecarFilters

分页展示过滤器

被如下接口引用：DescribeSidecarFilters

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总数
Content	是	否	Array of SidecarFilter	过滤器列表

GetContainGroupDeployInfoV2

获取容器部署信息(GetContainGroupDeployInfo) 【部署更新的时候需要获取部署组信息】输出参数

被如下接口引用：

名称	必选	允许NULL	类型	描述
GroupId	是	否	String	GroupId
GroupName	是	否	String	分组名称
InstanceNum	是	否	Int64	实例总数
CurrentNum	是	否	Int64	已启动的实例数
Server	是	否	String	镜像server
Reponame	是	否	String	镜像名，如/tsf/nginx
TagName	是	否	String	镜像版本名称
CpuRequest	是	否	String	预分配cpu 核数，如0.2，
CpuLimit	是	否	String	最大分配cpu 核数，如0.6
MemRequest	是	否	String	预分配内存M数
MemLimit	是	否	String	最大分配内存M数
AccessType	是	否	Int64	0:公网 1:集群内访问 2：NodePort
ProtocolPorts	是	否	Array of ProtocolPort	数组
UpdateType	是	否	Int64	更新方式：0:快速更新 1:滚动更新
UpdateIvl	是	否	Int64	更新间隔,单位秒
JvmOpts	是	否	String	jvm参数
ClusterId	是	否	String	无用
ClusterName	是	否	String	无用
ApplicationId	是	否	String	无用
ApplicationName	是	否	String	无用
ApplicationType	是	否	String	无用
KuberneteApiServer	是	否	String	无用
KuberneteUser	是	否	String	无用
KubernetePassword	是	否	String	无用
NamespaceId	是	否	String	无用
NamespaceName	是	否	String	无用
GroupComment	是	否	String	无用
PodId	是	否	String	无用
PodName	是	否	String	无用
ClusterIp	是	否	String	无用
LbIp	是	否	String	无用
NodePort	是	否	String	无用
IsStop	是	否	String	无用
Status	是	否	String	无用
Message	是	否	String	无用
ChangType	是	否	Int64	无用
ChangNum	是	否	Int64	无用
IsFirst	是	否	Int64	无用
CreateTime	是	否	String	无用
UpdateTime	是	否	String	无用
AppId	是	否	String	无用
SubAccountUin	是	否	String	无用
Uin	是	否	String	无用
Limit	是	否	Int64	无用
OrderType	是	否	String	无用

ApiDetailResponse

ApiDetailResponse描述

被如下接口引用：DescribeApiDetail

名称	必选	允许NULL	类型	描述
Request	是	否	Array of ApiRequestDescr	API 请求参数
Response	是	是	Array of ApiResponseDescr	API 响应参数
Definitions	是	否	Array of ApiDefinitionDescr	API 复杂结构定义
RequestContentType	是	是	String	API 的 content type
CanRun	是	是	Bool	API 能否调试
Status	是	是	Int64	API 状态 0:离线 1:在线，默认0
Description	是	是	String	API 描述

TsfPageRouteAffinity

TSF就近访问列表对象

被如下接口引用：DescribeNamespaceAffinities

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	TSF就近策略总数目
Content	是	是	Array of RouteAffinity	TSF就近策略列表

BusinessLogPatternAnalysis

日志Pattern合法性校验/模拟解析出参

被如下接口引用：AnalyzeLogSchema、ValidateLogSchema

名称	必选	允许NULL	类型	描述
Success	是	否	Bool	校验/解析是否成功
Hint	是	是	String	校验/解析用户提示，包含校验不通过的原因，是否成功联动调用链等
AnalyzeResult	是	是	Array of EnvsV2	解析结果，复用Envs对象，本质是一个Map<String, String>

ContainerTasksResultV2

变更记录任务列表

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	总记录数
Content	是	否	Array of ContainerTasks	列表信息

LaneRuleTag

泳道规则标签

被如下接口引用：CreateLaneRule、DescribeLaneRule、DescribeLaneRules、ModifyLaneRule

名称	必选	允许NULL	类型	描述
TagId	是	是	String	标签ID
TagName	是	是	String	标签名
TagOperator	是	是	String	标签操作符
TagValue	是	是	String	标签值
LaneRuleId	是	是	String	泳道规则ID
CreateTime	是	是	Int64	创建时间
UpdateTime	是	是	Int64	更新时间

ImageUserIsExists

镜像仓库用户是否已经开通

被如下接口引用：DescribeImageUserIsExists

名称	必选	允许NULL	类型	描述
IsExist	是	否	Bool	子账号是否存在,true：存在；false：不存在
MainIsExist	是	否	Bool	主账号是否存在，true：存在；false：不存在

RouteDestItemV2

服务路由目标匹配项

被如下接口引用：CreateRoute、DescribeRoute、DescribeRoutes、ModifyRoute

名称	必选	允许NULL	类型	描述
RouteDestItemId	否	是	String	路由规则路由目标匹配项ID
DestItemField	是	否	String	路由规则目标字段名称
DestItemValue	是	否	String	路由规则目标字段取值
RouteDestId	否	是	String	所属路由规则路由目标ID

ZipkinEndpointV2

调用链Span端点信息

被如下接口引用：DescribeSpanDetail、GetOssTraceSpans、SearchSpan

名称	必选	允许NULL	类型	描述
ServiceName	是	是	String	端点服务名
Ipv4	是	是	String	端点IP地址（v4）
Ipv6	是	是	String	端点IP地址（v6）
Port	是	是	Int64	端点端口号

GatewayGroupIds

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

被如下接口引用：BindApiGroup、UnbindApiGroup

名称	必选	允许NULL	类型	描述
GatewayDeployGroupId	是	否	String	网关部署组ID
GroupId	是	否	String	分组id

TemplatePageResultV2

TemplatePageResult

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	TotalCount
Content	是	否	Array of ProjectList	Content

TaskGroupPage

任务分组翻页查询结果

被如下接口引用：DescribeTaskGroups

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	总记录数
Content	是	否	Array of String	分组ID数组

TsfPageZipkinSpanInfo

调用链Span列表

被如下接口引用：GetTraceSpans

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总条目数
Content	是	是	Array of ZipkinSpanInfo	调用链Span列表

TsfPageConfigSummary

TsfPage<Config>

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	总条数
Content	是	否	Array of ConfigSummary	配置项列表

ServiceInfo

微服务明细

被如下接口引用：

名称	必选	允许NULL	类型	描述
MicroserviceId	是	是	String	微服务ID
MicroserviceName	是	是	String	微服务名称

OverviewResourceV2

资源概览数据信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
ClusterCount	是	是	Int64	集群数目
NamespaceCount	是	是	Int64	命名空间数目
InstanceCount	是	是	Int64	实例总数目
RunInstanceCount	是	是	Int64	运行中实例数目
OffInstanceCount	是	是	Int64	停止实例数目
UnNormalInstanceCount	是	是	Int64	异常实例数目
ApplicationCount	是	是	Int64	应用数目
GroupCount	是	是	Int64	部署组数目

ListMonitorStatisticsPolicyResultV2

ListMonitorStatisticsPolicy结果返回类型

被如下接口引用：

名称	必选	允许NULL	类型	描述
PolicyId	是	否	String	监控统计策略id
KeyWords	是	否	String	关键词
GroupList	是	否	GroupList	部署组列表信息
NamespaceId	是	否	String	命名空间id
CreateTime	是	否	String	创建时间
UpdateTime	是	否	String	更新时间

ConfigTemplateResult

配置模板列表

被如下接口引用：DescribeConfigTemplates

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总数目
Content	是	是	Array of ConfigTemplate	配置模板列表

ModuleParamResult

被如下接口引用：FindDeployModuleParams

名称	必选	允许NULL	类型	描述
ParameterName	是	是	String	ParameterName
ParameterValue	是	是	String	ParameterValue
ParameterType	是	是	String	ParameterType
ParameterEnums	是	是	String	ParameterEnums
Desc	是	是	String	Desc
Demo	是	是	String	Demo
ParameterId	是	是	String	ParameterId
Visible	是	是	String	Visible
ParameterConfigType	是	是	String	ParameterConfigType
ParameterSubType	是	是	String	ParameterSubType

MsInstance

微服务实例信息

被如下接口引用：DescribeMicroservice

名称	必选	允许NULL	类型	描述
InstanceId	是	是	String	机器实例ID信息
InstanceName	是	是	String	机器实例名称信息
Port	是	是	String	服务运行的端口号
LanIp	是	是	String	机器实例内网IP
WanIp	是	是	String	机器实例外网IP
InstanceAvailableStatus	是	是	String	机器可用状态
ServiceInstanceStatus	是	是	String	服务运行状态
ApplicationId	是	是	String	应用ID
ApplicationName	是	是	String	应用名称
ClusterId	是	是	String	集群ID
ClusterName	是	是	String	集群名称
NamespaceId	是	是	String	命名空间ID
NamespaceName	是	是	String	命名空间名称
GroupId	是	是	String	部署组ID
GroupName	是	是	String	部署组名称
InstanceStatus	是	是	String	机器TSF可用状态
HealthCheckUrl	是	是	String	健康检查URL
ClusterType	是	是	String	集群类型
ApplicationPackageVersion	是	是	String	应用程序包版本
ApplicationType	是	是	String	应用类型
ServiceStatus	是	是	String	服务状态，passing 在线，critical 离线
RegistrationTime	是	是	Int64	注册时间
LastHeartbeatTime	是	是	Int64	上次心跳时间
RegistrationId	是	是	String	实例注册id
HiddenStatus	是	是	String	屏蔽状态，hidden 为屏蔽，unhidden 为未屏蔽

TsfPageTraceSpanInfo

分页spaninfo的结构

被如下接口引用：SearchSpan

名称	必选	允许NULL	类型	描述
TotalCount	否	是	Uint64	总数
Content	否	是	Array of TraceSpanInfo	span列表

MsInstanceWrong

微服务实例信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
InstanceId	是	是	String	机器实例ID信息
InstanceName	是	是	String	机器名称信息
InstancePort	是	是	Int64	机器运行的端口号
LanIp	是	是	String	机器实例内网IP
WanIp	是	是	String	机器实例外网IP
InstanceAvailableStatus	是	是	String	机器实例可用状态
ServiceInstanceStatus	是	是	String	服务运行状态
PkgVersion	是	是	String	程序包版本
ApplicationId	是	是	String	应用ID
ApplicationName	是	是	String	应用名称
ClusterId	是	是	String	集群ID
ClusterName	是	是	String	集群名称
NamespaceId	是	是	String	命名空间ID
NamespaceName	是	是	String	命名空间名称
GroupId	是	是	String	部署组ID
GroupName	是	是	String	部署组名称
InstanceStatus	是	是	String	机器TSF可用状态
PodName	是	是	String	容器pod名
PodId	是	是	String	容器pod ID
Status	是	是	String	容器状态
NodeIp	是	是	String	容器node IP
Ip	是	是	String	容器IP
Reponame	是	是	String	容器仓库名
TagName	是	是	String	容器tag

PagedService

tsf-privilege模块，分页产品列表

被如下接口引用：DescribeServices

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	总条数
Content	是	否	Array of Service	产品列表

ContainGroupResultV2

部署组列表（应用下钻）

被如下接口引用：

名称	必选	允许NULL	类型	描述
Content	是	是	Array of ContainGroup	部署组列表
TotalCount	是	否	Int64	总记录数

ImageUserIsExistsV2

镜像仓库用户是否已经开通

被如下接口引用：

名称	必选	允许NULL	类型	描述
IsExist	是	否	Bool	子账号是否存在,true：存在；false：不存在
MainIsExist	是	否	Bool	主账号是否存在，true：存在；false：不存在

MsV2

被如下接口引用：

名称	必选	允许NULL	类型	描述
MsName	是	是	String	MsName
MsPort	是	是	String	MsPort
Controller	是	是	Array of Controller	Controller
Provider	是	是	Array of Provider	Provider
Consumer	是	是	Array of Consumer	Consumer

TxMainTransaction

主事务描述

被如下接口引用：DescribeTransactions

名称	必选	允许NULL	类型	描述
TransactionId	是	是	String	事务Id
ServerIp	是	是	String	服务器Ip
ServiceName	是	是	String	服务名称
MethodName	是	是	String	方法名
SubCount	是	是	Int64	子事务数量
StartTime	是	是	String	创建时间
EndTime	是	是	String	更新时间
Status	是	是	Int64	事务状态
TimeoutMs	是	是	Int64	超时时间
RetryTimes	是	是	Int64	重试次数
AutoRetry	是	是	Bool	是否开启自动重试

ConfigTemplateV2

配置模板对象

被如下接口引用：

名称	必选	允许NULL	类型	描述
ConfigTemplateId	否	是	String	配置模板Id
ConfigTemplateName	否	是	String	配置模板名称
ConfigTemplateDesc	否	是	String	配置模板描述
ConfigTemplateType	否	是	String	配置模板对应的微服务框架
ConfigTemplateValue	否	是	String	配置模板数据
CreateTime	否	是	String	创建时间
UpdateTime	否	是	String	更新时间

InterfaceStatistic

接口统计

被如下接口引用：DescribeInterfaceStatistic

名称	必选	允许NULL	类型	描述
Path	是	否	String	请求路径模版
Method	是	否	String	请求方法
RequestCount	是	是	Int64	接口请求量
ErrorRate	是	是	Float	错误率0-1之间小数
AvgTimeConsuming	是	是	Int64	平均耗时,单位ms
P50	是	是	Int64	p50,单位ms
P99	是	是	Int64	p99,单位ms

VolumeInfo

容器卷挂载信息

被如下接口引用：DeployContainerGroup

名称	必选	允许NULL	类型	描述
VolumeType	是	否	String	数据卷类型
VolumeName	是	否	String	数据卷名称
VolumeConfig	否	否	String	数据卷配置

ImageInfo

镜像信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
ImageId	是	是	String	ImageId
OsName	是	是	String	OsName
ImageSize	是	是	Int64	ImageSize
ImageType	是	是	String	ImageType
ImageName	是	是	String	ImageName
ImageDesc	是	是	String	ImageDesc
CreateTime	是	是	String	CreateTime
LoginName	是	是	String	LoginName

ThreadDetailInfos

线程详情信息数组

被如下接口引用：DescribeThreadDetailList

名称	必选	允许NULL	类型	描述
Content	是	是	Array of ThreadDetailInfo	线程详情数组
TotalCount	是	是	Int64	接口执行状态success/error

GetContainGroupOtherResult

部署组其他字段获取

被如下接口引用：GetContainGroupOther

名称	必选	允许NULL	类型	描述
InstanceNum	是	否	Int64	实例总数
CurrentNum	是	否	Int64	已启动实例总数
LbIp	是	否	String	负载均衡ip
ClusterIp	是	否	String	Service ip
Status	是	否	String	服务状态，请参考后面的的状态定义
Message	是	否	String	异常信息,服务状态为Abnormal时才有

SimpleCluster

简单集群

被如下接口引用：

名称	必选	允许NULL	类型	描述
ClusterId	是	是	String	集群ID
ClusterName	是	是	String	集群名称
ClusterType	是	是	String	集群类型

ApiRateLimitRule

微服务网关API限流规则

被如下接口引用：DescribeApiRateLimitRules

名称	必选	允许NULL	类型	描述
RuleId	是	是	String	rule Id
ApiId	是	是	String	API ID
RuleName	是	是	String	限流名称
MaxQps	是	是	Uint64	最大限流qps
UsableStatus	是	是	String	生效/禁用, enabled/disabled
RuleContent	是	是	String	规则内容
TsfRuleId	是	是	String	Tsf Rule ID
Description	是	是	String	描述
CreatedTime	是	是	String	创建时间
UpdatedTime	是	是	String	更新时间

Config

配置项

被如下接口引用：DescribeConfig、DescribeConfigSummary、DescribeConfigs、DescribePublicConfig、DescribePublicConfigSummary、DescribePublicConfigs

名称	必选	允许NULL	类型	描述
ConfigId	是	是	String	配置项ID
ConfigName	是	是	String	配置项名称
ConfigVersion	是	是	String	配置项版本
ConfigVersionDesc	是	是	String	配置项版本描述
ConfigValue	是	是	String	配置项值
ConfigType	是	是	String	配置项类型
CreationTime	是	是	String	创建时间
ApplicationId	是	是	String	应用ID
ApplicationName	是	是	String	应用名称
DeleteFlag	是	是	Bool	删除标识，true：可以删除；false：不可删除
LastUpdateTime	是	是	String	最后更新时间
ConfigVersionCount	是	是	Int64	配置项版本数量

TaskFlowBatchLastState

工作流最近批次状态

被如下接口引用：

名称	必选	允许NULL	类型	描述
FlowBatchId	是	是	String	批次ID
FlowBatchLogId	是	是	String	批次历史ID
State	是	是	String	状态

Role

tsf-privilege模块 Role 角色

被如下接口引用：DescribeRole、DescribeRoles

名称	必选	允许NULL	类型	描述
RoleId	否	是	String	角色ID
RoleName	否	是	String	角色名称
RoleDesc	否	是	String	角色描述
DeleteFlag	否	是	Bool	删除标识
PermCatList	否	是	Array of PermCat	角色权限集列表
CreationTime	否	是	Int64	创建时间
LastUpdateTime	否	是	Int64	最后更新时间

ApplicationForPage

分页的应用描述信息字段

被如下接口引用：DescribeApplication、DescribeApplications

名称	必选	允许NULL	类型	描述
ApplicationId	是	是	String	应用ID
ApplicationName	是	是	String	应用名称
ApplicationDesc	是	是	String	应用描述
ApplicationType	是	是	String	应用类型
MicroserviceType	是	是	String	微服务类型
ProgLang	是	是	String	编程语言
CreateTime	是	是	String	创建时间
UpdateTime	是	是	String	更新时间
ApplicationResourceType	是	是	String	应用资源类型
ApplicationRuntimeType	是	是	String	应用runtime类型
ApigatewayServiceId	是	是	String	Apigateway的serviceId
ApplicationRemarkName	是	是	String	应用备注名
ServiceConfigList	否	是	Array of ServiceConfig	服务配置信息列表

AgentTask

DescribeApmTaskStatus 接口返回参数封装

被如下接口引用：DescribeApmTaskStatus

名称	必选	允许NULL	类型	描述
TaskId	是	是	String	任务Id
InstanceId	是	是	String	查询的实例Id
Type	是	是	String	任务类型
Status	是	是	String	任务执行状态 AVAILABLE(可执行), BUSY(执行中), ERROR(执行出错), COMPLETED(执行成功)
StatusInfo	是	是	String	status 为ERROR时该字段才有值. EXCEED_SIZE表示采集数据过大, MAL_FUNC表示内部错误 NO_CONNECTION 表示无法和用户进程建立连接, EXECUTE_TIMEOUT 表示任务执行超时
CreationTime	是	是	String	任务创建时间,格式为(yyyy-MM-dd HH:mm:ss)
MetaInfo	是	是	String	元数据,该任务的部分请求参数,如火焰图采集时长{"duration":30}
ExecutedTime	是	是	Int64	任务已执行时长, 单位:秒

SpanLabel

Span标签

被如下接口引用：DescribeSpanDetail、GetOssTraceSpans、SearchSpan

名称	必选	允许NULL	类型	描述
Key	否	是	String	标签键
Value	否	是	String	标签值

TsfPageAuthRule

TSF标准分页的AuthRule列表

被如下接口引用：DescribeAuthorizations

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	总数量
Content	是	否	Array of AuthRule	微服务权限规则列表

TsfPageConfigReleaseV2

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

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总条数
Content	是	是	Array of ConfigRelease	配置项发布信息数组

SecretKeyInfo

微服务网关密钥信息

被如下接口引用：ChangeSecretStatus、DescribeGroupSecrets、UpdateGroupSecret

名称	必选	允许NULL	类型	描述
SecretName	是	是	String	secret 名称
SecretId	是	是	String	secret Id
SecretKey	是	是	String	secret key
CreatedTime	是	是	String	创建时间，格式 yyyy-MM-dd HH:mm:ss
Status	是	是	String	enabled: 启用状态。disabled: 禁用状态
Id	是	是	String	密钥ID
GwSecretId	是	是	String	secret Id
ExpiredTime	是	是	String	过期时间，格式 yyyy-MM-dd HH:mm:ss
UpdatedTime	是	是	String	更新时间，格式 yyyy-MM-dd HH:mm:ss
GroupId	是	是	String	API分组ID

VmGroupForPage

虚拟机部署组列表中使用到的虚拟机信息字段

被如下接口引用：

名称	必选	允许NULL	类型	描述
ApplicationId	是	是	String	应用Id
ApplicationName	是	是	String	应用名称
ApplicationType	是	是	String	应用类型
ClusterId	是	是	String	集群Id
ClusterName	是	是	String	集群名称
NamespaceId	是	是	String	命名空间Id
NamespaceName	是	是	String	命名空间名称
GroupId	是	是	String	分组id
GroupName	是	是	String	分组名称
GroupDesc	是	是	String	分组描述
CreateTime	是	是	String	分组创建时间
UpdateTime	是	是	String	分组更新时间
StartupParameters	是	是	String	部署组启动参数
PkgId	是	是	String	程序包Id

ApiDefinitionDescr

API 对象类型描述

被如下接口引用：DescribeApiDetail

名称	必选	允许NULL	类型	描述
Name	是	否	String	对象名称
Properties	是	否	Array of PropertyField	对象属性列表

OverviewInstanceResourceUsage

实例相关信息概览

被如下接口引用：DescribeInstanceResourceUsage

名称	必选	允许NULL	类型	描述
ClusterCount	是	是	Int64	集群数目
InstanceCount	是	是	Int64	实例总数目
UnNormalClusterCount	是	是	Int64	异常集群数目
UnNormalInstanceCount	是	是	Int64	异常实例数目
RunInstanceCount	是	是	Int64	运行中实例数目
OffInstanceCount	是	是	Int64	停止实例数目

TsfPageMicroserviceWrong

微服务列表信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总数目
Content	是	是	Array of MicroserviceWrong	微服务列表信息

MetricDataPointMap

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

被如下接口引用：DescribeUnitApiUseDetail

名称	必选	允许NULL	类型	描述
SumReqAmount	是	否	Array of InvocationMetricDataPoint	总调用次数监控数据点集合
AvgFailureRate	是	否	Array of InvocationMetricDataPoint	平均错误率监控数据点集合
AvgTimeCost	是	否	Array of InvocationMetricDataPoint	平均响应时间监控数据点集合

ProviderV2

provider

被如下接口引用：

名称	必选	允许NULL	类型	描述
ProviderControllerName	是	是	String	ProviderControllerName

InstanceInfo

实例信息

被如下接口引用：DescribeInterfaceRequest

名称	必选	允许NULL	类型	描述
InstanceId	否	是	String	实例id
GroupId	否	是	String	部署id
ClusterType	否	是	String	集群类型
InstanceIp	否	是	String	实例ip

LicenseApplicationRecord

被如下接口引用：DescribeLicenseApplications

名称	必选	允许NULL	类型	描述
CreateTime	是	否	Uint64	创建时间
Grantee	是	否	LicenseGrantee	授予对象
Product	否	否	Array of LicenseProduct	所申请的产品信息列表
Phone	否	是	Array of String	联系电话
Email	否	是	Array of String	联系邮箱
Description	否	是	String	备注
IssueTime	否	是	Uint64	授予许可时间
Duration	否	是	LicenseDuration	有效期信息

VmGroupForPageV2

虚拟机部署组列表中使用到的虚拟机信息字段

被如下接口引用：

名称	必选	允许NULL	类型	描述
ApplicationId	是	是	String	应用Id
ApplicationName	是	是	String	应用名称
ApplicationType	是	是	String	应用类型
ClusterId	是	是	String	集群Id
ClusterName	是	是	String	集群名称
NamespaceId	是	是	String	命名空间Id
NamespaceName	是	是	String	命名空间名称
GroupId	是	是	String	分组id
GroupName	是	是	String	分组名称
GroupDesc	是	是	String	分组描述
CreateTime	是	是	String	分组创建时间
UpdateTime	是	是	String	分组更新时间
StartupParameters	是	是	String	部署组启动参数
PkgId	是	是	String	程序包Id

GroupPod

部署组实例列表

被如下接口引用：DescribePodInstances

名称	必选	允许NULL	类型	描述
PodName	是	是	String	实例名称(对应到kubernetes的pod名称)
PodId	是	是	String	实例ID(对应到kubernetes的pod id)
Status	是	是	String	实例状态，请参考后面的实例以及容器的状态定义
Reason	是	是	String	实例处于当前状态的原因，例如容器下载镜像失败
NodeIp	是	是	String	主机IP
Ip	是	是	String	实例IP
RestartCount	是	是	Int64	实例中容器的重启次数
ReadyCount	是	是	Int64	实例中已就绪容器的个数
Runtime	是	是	String	运行时长
CreatedAt	是	是	String	实例启动时间
ServiceInstanceStatus	是	是	String	服务实例状态
InstanceAvailableStatus	是	是	String	机器实例可使用状态
InstanceStatus	是	是	String	机器实例状态
NodeInstanceId	是	是	String	节点实例id

VmGroupSimple

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

被如下接口引用：DescribeGroups

名称	必选	允许NULL	类型	描述
GroupId	是	是	String	部署组ID
GroupName	是	是	String	部署组名称
ApplicationType	是	是	String	应用类型
GroupDesc	是	是	String	部署组描述
UpdateTime	是	是	String	部署组更新时间
ClusterId	是	是	String	集群ID
StartupParameters	是	是	String	部署组启动参数
NamespaceId	是	是	String	命名空间ID
CreateTime	是	是	String	部署组创建时间
ClusterName	是	是	String	集群名称
ApplicationId	是	是	String	应用ID
ApplicationName	是	是	String	应用名称
NamespaceName	是	是	String	命名空间名称
MicroserviceType	是	是	String	应用微服务类型
GroupResourceType	是	是	String	部署组资源类型
UpdatedTime	是	是	Int64	部署组更新时间戳
DeployDesc	是	是	String	部署应用描述信息

BillingLicense

计费许可

被如下接口引用：DescribeAllBillingLicenses

名称	必选	允许NULL	类型	描述
Id	是	否	String	许可ID
AppId	是	否	String	租户ID
Uin	是	是	String	账号ID
SpecType	是	是	Int64	规格类型
Spec	是	是	String	规格
NodeSize	是	是	Int64	节点数
Resource	是	是	String	资源
Function	是	是	String	功能
Status	是	是	Int64	状态
SourceType	是	是	Int64	来源类型
AutoRenewFlag	是	是	Int64	自动续费标记
CreateTime	是	是	String	创建时间
ModifyTime	是	是	String	修改时间
IsolateTime	是	是	String	隔离时间
WhitelistType	是	是	Int64	白名单类型，0 正常，1 不收费白名单内
Nickname	是	是	String	昵称
ExpireTime	是	是	String	过期时间
BillingRecordCount	是	是	Int64	订单数

PagedPermission

分页权限点

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	总条数
Content	是	否	Array of Permission	权限点列表

TaskExecuteRecordPage

翻页查询任务执行返回结果

被如下接口引用：DescribeTaskExecuteRecords

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Uint64	总数量
Content	是	否	Array of TaskExecuteRecord	任务执行列表

DescribeSingleContainerGroupsResultV2

DescribeSingleContainerGroupsResult

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	列表数量
Content	是	是	Array of DescribeSingleContainerGroups	列表内容

InstancesResult

被如下接口引用：ListTsfModulesDetail

名称	必选	允许NULL	类型	描述
Ip	是	是	String	Ip值
Status	是	是	String	Status值
Ports	是	是	Array of PortsResult	Ports值
InstanceId	是	是	String	InstanceId值
ModuleId	是	是	String	ModuleId值
ModuleName	是	是	String	ModuleName值
ModuleType	是	是	String	ModuleType值
UserName	是	是	String	UserName值
Password	是	是	String	Password值
ModuleCommon	是	是	Int64	ModuleCommon值
UpdateTime	是	是	String	UpdateTime值
DeployTime	是	是	String	DeployTime值
MachineId	是	是	String	MachineId值
ZoneId	是	是	String	ZoneId值
ZoneName	是	是	String	ZoneName值
ModuleRole	是	是	String	ModuleRole值
SshPort	是	是	Int64	SshPort值

AuthMicroserviceV2

在 TSF Auth 中使用的微服务结构体

被如下接口引用：

名称	必选	允许NULL	类型	描述
MicroserviceId	是	否	String	服务 ID
MicroserviceName	是	否	String	服务名
NamespaceId	是	否	String	命名空间 ID
IsNotExist	是	否	Bool	服务是否存在
AppId	是	否	String	帐号 appid
Uin	是	否	String	账号 uin
SubAccountUin	是	否	String	子账号 uin

ContainerGroupDeployV2

获取部署组

被如下接口引用：

名称	必选	允许NULL	类型	描述
GroupId	是	是	String	groupId
GroupName	是	是	String	分组名称
InstanceNum	是	是	Int64	实例总数
CurrentNum	是	是	Int64	已启动实例总数
Server	是	是	String	镜像server
Reponame	是	是	String	镜像名，如/tsf/nginx
TagName	是	是	String	镜像版本名称
CpuRequest	是	是	String	初始分配的 CPU 核数，对应 K8S request
CpuLimit	是	是	String	最大分配的 CPU 核数，对应 K8S limit
MemRequest	是	是	String	初始分配的内存 MiB 数，对应 K8S request
MemLimit	是	是	String	最大分配的内存 MiB 数，对应 K8S limit
AccessType	是	是	Int64	0:公网 1:集群内访问 2：NodePort
ProtocolPorts	是	是	Array of ProtocolPort	ProtocolPorts
UpdateType	是	是	Int64	更新方式：0:快速更新 1:滚动更新
UpdateIvl	是	是	Int64	更新间隔,单位秒
JvmOpts	是	是	String	jvm参数
SubnetId	是	是	String	子网id

SimpleKafkaDeliveryConfig

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

被如下接口引用：DescribeDeliveryConfigByGroupId

名称	必选	允许NULL	类型	描述
ConfigId	是	是	String	配置项id
ConfigName	是	是	String	配置项名称

TsfPageRouteRule

Tsf 路由规则分页路由

被如下接口引用：DescribeRouteRules

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总数目
Content	是	是	Array of RouteRule	路由规则数组

TsfPageStdoutLog

标准输出日志列表

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总条数
Content	是	是	Array of StdoutLog	标准输出日志列表

ZipkinBinaryAnnotation

调用链Span二进制注解

被如下接口引用：GetTraceSpans

名称	必选	允许NULL	类型	描述
Key	是	是	String	注解键
Value	是	是	String	注解值
Endpoint	是	是	ZipkinEndPoint	注解端点信息

AppPkgList

应用的包列表

被如下接口引用：ListAppPkg

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	程序包总量
Content	是	是	Array of AppPkgInfo	应用的包列表

DescribeResourceConfigClusterContainer

返回给前端的控制信息

被如下接口引用：DescribeResourceConfig

名称	必选	允许NULL	类型	描述
NeedSubnetWhenCreatingCluster	是	是	Bool	是否需要子网

FunctionStatusResult

功能状态返回结果

被如下接口引用：DescribeFunctionStatus

名称	必选	允许NULL	类型	描述
Enable	是	是	Bool	是否开启
Used	是	是	Bool	是否使用过
ForbiddenActions	是	是	Array of String	关闭时需要禁用的Action列表
FunctionName	是	是	String	功能名称

RouteReleaseHistory

路由规则启停记录

被如下接口引用：DescribeRouteReleaseHistory

名称	必选	允许NULL	类型	描述
RouteReleaseLogId	是	是	String	路由规则发布记录id
MicroserviceId	是	是	String	微服务id
RouteRuleId	是	是	String	路由规则Id
EnableTime	是	是	String	路由规则部署开始时间
DisableTime	是	是	String	路由规则停止时间
ReleaseDesc	是	是	String	路由规则发布
RouteRule	是	是	RouteRule	路由规则详情
AppId	是	是	String	账号APPID
Uin	是	是	String	账号Owner用户唯一ID
SubAccountUin	是	是	String	账号用户唯一ID

ThreadPicture

jvm监控数据线程数据封装

被如下接口引用：DescribeJvmMonitor

名称	必选	允许NULL	类型	描述
ThreadCount	是	否	Array of CurvePoint	总线程数
ThreadActive	是	否	Array of CurvePoint	活跃线程数
DeamonThreadCount	是	否	Array of CurvePoint	守护线程数

CloudMonitorPolicyResult

云监控对象策略对象

被如下接口引用：ListColudMonitorStatisticsPolicy

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	TotalCount
Content	是	是	Array of CloudMonitorPolicies	Content

RatelimitRule

限流规则

被如下接口引用：

名称	必选	允许NULL	类型	描述
Id	否	否	String	规则ID
Name	是	否	String	规则名字，在一个微服务下唯一
Status	否	否	Uint64	状态 0表示启用 1表示停用
SourceService	否	是	String	限流规则区分的来源微服务名
DurationSecond	是	否	Uint64	限流周期，单位秒
DurationQuota	是	否	Uint64	每周期内的限流配额
ModifyTime	否	否	Uint64	最近一次修改规则时间，UTC秒数
Description	否	是	String	描述
Dimensions	是	是	Array of RatelimitDimension	限制条件列表

GetContainGroupDeployInfo

获取容器部署信息(GetContainGroupDeployInfo) 【部署更新的时候需要获取部署组信息】输出参数

被如下接口引用：GetContainGroupDeployInfo

名称	必选	允许NULL	类型	描述
GroupId	是	否	String	GroupId
GroupName	是	否	String	分组名称
InstanceNum	是	否	Int64	实例总数
CurrentNum	是	否	Int64	已启动的实例数
Server	是	否	String	镜像server
Reponame	是	否	String	镜像名，如/tsf/nginx
TagName	是	否	String	镜像版本名称
CpuRequest	是	否	String	预分配cpu 核数，如0.2，
CpuLimit	是	否	String	最大分配cpu 核数，如0.6
MemRequest	是	否	String	预分配内存M数
MemLimit	是	否	String	最大分配内存M数
AccessType	是	否	Int64	0:公网 1:集群内访问 2：NodePort
ProtocolPorts	是	否	Array of ProtocolPort	数组
UpdateType	是	否	Int64	更新方式：0:快速更新 1:滚动更新
UpdateIvl	是	否	Int64	更新间隔,单位秒
JvmOpts	是	否	String	jvm参数
ClusterId	是	否	String	无用
ClusterName	是	否	String	无用
ApplicationId	是	否	String	无用
ApplicationName	是	否	String	无用
ApplicationType	是	否	String	无用
KuberneteApiServer	是	否	String	无用
KuberneteUser	是	否	String	无用
KubernetePassword	是	否	String	无用
NamespaceId	是	否	String	无用
NamespaceName	是	否	String	无用
GroupComment	是	否	String	无用
PodId	是	否	String	无用
PodName	是	否	String	无用
ClusterIp	是	否	String	无用
LbIp	是	否	String	无用
NodePort	是	否	String	无用
IsStop	是	否	String	无用
Status	是	否	String	无用
Message	是	否	String	无用
ChangType	是	否	Int64	无用
ChangNum	是	否	Int64	无用
IsFirst	是	否	Int64	无用
CreateTime	是	否	String	无用
UpdateTime	是	否	String	无用
AppId	是	否	String	无用
SubAccountUin	是	否	String	无用
Uin	是	否	String	无用
Limit	是	否	Int64	无用
OrderType	是	否	String	无用

TsfPageBusinessLogConfig

业务日志配置项列表

被如下接口引用：DescribeBusinessLogConfigs、DescribeGroupBusinessLogConfigs

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总条数
Content	是	是	Array of BusinessLogConfig	业务日志配置项列表

TemplateResult

被如下接口引用：DescribeTemplates

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	TotalCount
Content	是	是	Array of TemplateProject	Content

ContainerGroupOtherV2

部署组列表-其它字段

被如下接口引用：

名称	必选	允许NULL	类型	描述
InstanceNum	是	否	Int64	实例总数
CurrentNum	是	否	Int64	已启动实例总数
LbIp	是	否	String	负载均衡ip
ClusterIp	是	否	String	Service ip
Status	是	否	String	服务状态，请参考后面的的状态定义
Message	是	否	String	服务状态，请参考后面的的状态定义
Envs	是	否	Array of Env	环境变量

TemplatePageResult

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	TotalCount
Content	是	否	Array of ProjectList	Content

TsfPageVmGroupV2

列表中部署组分页信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总数目
Content	是	是	Array of VmGroupSimple	部署组列表信息

AuthMicroservice

在 TSF Auth 中使用的微服务结构体

被如下接口引用：DescribeAuthorizationInfo、ModifyAuthorizationInfo

名称	必选	允许NULL	类型	描述
MicroserviceId	是	否	String	服务 ID
MicroserviceName	是	否	String	服务名
NamespaceId	是	否	String	命名空间 ID
IsNotExist	是	否	Bool	服务是否存在
AppId	是	否	String	帐号 appid
Uin	是	否	String	账号 uin
SubAccountUin	是	否	String	子账号 uin

ResourceOperationStatusResult

描述操作执行结果

被如下接口引用：InterruptResourceBatchOperation

名称	必选	允许NULL	类型	描述
OperationResult	是	否	Bool	操作的执行状态

DtsRetryError

DTS重试事务异常信息

被如下接口引用：RetryTransactions

名称	必选	允许NULL	类型	描述
TxId	是	否	Int64	主事务ID
ErrorMessage	是	是	String	异常信息

PathRewritePage

路径重写翻页对象

被如下接口引用：DescribePathRewrites

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	总记录数
Content	是	否	Array of PathRewrite	路径重写规则列表

ResourceGetBatchIndexResult

获取执行批次索引的描述

被如下接口引用：GetResourceBatchIndex

名称	必选	允许NULL	类型	描述
BatchNum	是	否	Uint64	执行批次索引

TsfPageCluster

Tsf分页集群对象

被如下接口引用：DescribeSimpleClusters

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总条数
Content	是	是	Array of Cluster	集群列表

TsfZone

TSF可用区信息

被如下接口引用：DescribeTsfZones

名称	必选	允许NULL	类型	描述
Id	是	是	String	TSF可用区ID
Name	是	是	String	TSF可用区名称
TsfRegionId	是	是	String	TSF可用区所属TSF地域ID

InstanceResourceConfig

实例相关的参数配置

被如下接口引用：DescribeResourceConfig

名称	必选	允许NULL	类型	描述
Container	是	是	ContainerInstanceResourceConfig	容器实例相关的参数配置
Vm	是	是	VmInstanceResourceConfig	虚拟机实例相关的参数配置

MicroserviceGroup

微服务下的部署组（对服务实例按照部署组进行归类）

被如下接口引用：DescribeMicroserviceGroups

名称	必选	允许NULL	类型	描述
GroupId	是	是	String	部署组ID
GroupName	是	是	String	部署组名称
ApplicationId	是	是	String	应用ID
ApplicationName	是	是	String	应用名称
ClusterId	是	是	String	集群ID
ClusterName	是	是	String	集群名称
ConsulInstanceCount	是	是	Int64	注册中心在线节点数
ClusterType	是	是	String	集群类型
AppMicroServiceType	是	是	String	应用微服务类型

ZipkinMetadataV2

调用链Span元数据

被如下接口引用：GetOssTraceSpans

名称	必选	允许NULL	类型	描述
Value	是	是	String	元数据值
Timestamp	是	是	Uint64	元数据时间戳
Endpoint	是	是	ZipkinEndpointV2	元数据端点信息

ApplicationAttribute

应用列表其它字段

被如下接口引用：DescribeApplicationAttribute、DescribeApplicationsAttribute、DescribeApplicationsOther

名称	必选	允许NULL	类型	描述
InstanceCount	是	是	Int64	总实例个数
RunInstanceCount	是	是	Int64	运行实例个数
GroupCount	是	是	Int64	应用下部署组个数

TsfPageRouteReleaseHistoryV2

路由规则启停记录分页对象

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	服务路由部署记录列表总数目
Content	是	是	Array of RouteReleaseHistoryV2	服务路由规则部署记录列表信息

TsfPageInstanceV2

TSF机器实例分页对象

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总条数
Content	是	是	Array of Instance	机器实例列表

ApiDailyUseStatisticsEntity

被如下接口引用：DescribeUnitApiUseDetail

名称	必选	允许NULL	类型	描述
Name	是	是	String	name
Count	是	是	String	count
Ratio	是	是	String	ratio

ConfigReleaseV2

配置项发布信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
ConfigReleaseId	是	是	String	配置项发布ID
ConfigId	是	是	String	配置项ID
ConfigName	是	是	String	配置项名称
ConfigVersion	是	是	String	配置项版本
ReleaseTime	是	是	String	发布时间
GroupId	是	是	String	部署组ID
GroupName	是	是	String	部署组名称
NamespaceId	是	是	String	命名空间ID
NamespaceName	是	是	String	命名空间名称
ClusterId	是	是	String	集群ID
ClusterName	是	是	String	集群名称
ReleaseDesc	是	是	String	发布描述

DtsGroup

事务分组

被如下接口引用：

名称	必选	允许NULL	类型	描述
GroupId	是	是	String	事务分组ID
GroupName	是	是	String	事务分组名称
GroupDesc	是	是	String	事务分组描述
CreationTime	是	是	Int64	创建时间戳，UTC，精确到毫秒
LastUpdateTime	是	是	Int64	更新时间戳，UTC，精确到毫秒
DeleteFlag	是	是	Bool	删除标识，true：可以删除；false：不可删除

TsfPageApiDetailInfo

ApiDetailInfo 翻页对象

被如下接口引用：DescribeApisWithPlugin、DescribeGatewayApis、DescribeUsableApis

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	总记录数
Content	是	否	Array of ApiDetailInfo	API 信息列表

UnitRuleItem

微服务网关单元化规则项

被如下接口引用：CreateUnitRule、DescribeEnabledUnitRule、DescribeUnitRule、DescribeUnitRules、UpdateUnitRule

名称	必选	允许NULL	类型	描述
Id	否	是	String	规则项ID
UnitRuleId	否	是	String	单元化规则ID
Relationship	是	否	String	逻辑关系：AND/OR
DestNamespaceId	是	否	String	目的地命名空间ID
DestNamespaceName	是	否	String	目的地命名空间名称
Name	是	否	String	规则项名称
Priority	否	是	Int64	规则顺序，越小优先级越高：默认为0
Description	否	是	String	规则描述
UnitRuleTagList	否	是	Array of UnitRuleTag	规则标签列表

SubTransaction

子事务详情

被如下接口引用：

名称	必选	允许NULL	类型	描述
TransactionId	是	否	String	事务ID
ServiceName	是	否	String	事务服务名
MethodName	是	否	String	事务调用方法
StartTime	是	否	String	事务开始时间
EndTime	是	否	String	事务结束时间
Status	是	否	Int64	事务状态
InvokeType	是	否	Int64	事务触发类型
Args	是	否	String	事务参数

TsfPageCommonPkg

公共包列表

被如下接口引用：DescribeCommonPkg

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	总数
Content	是	否	Array of CommonPkg	公共包信息

TaskIdV2

任务id

被如下接口引用：

名称	必选	允许NULL	类型	描述
TaskId	是	是	String	任务Id

ThreadDetails

DescribeThreadDetail接口返回的数据列表

被如下接口引用：DescribeThreadDetail

名称	必选	允许NULL	类型	描述
Data	是	是	Array of ThreadDetail	线程详情列表
Status	是	是	String	接口执行状态success/error
StatusInfo	是	是	String	success时为"", error时为错误信息
StatusCode	是	是	Int64	success时为, error时为错误码

OverviewResource

资源概览数据信息

被如下接口引用：DescribeOverviewResource

名称	必选	允许NULL	类型	描述
ClusterCount	是	是	Int64	集群数目
NamespaceCount	是	是	Int64	命名空间数目
InstanceCount	是	是	Int64	实例总数目
RunInstanceCount	是	是	Int64	运行中实例数目
OffInstanceCount	是	是	Int64	停止实例数目
UnNormalInstanceCount	是	是	Int64	异常实例数目
ApplicationCount	是	是	Int64	应用数目
GroupCount	是	是	Int64	部署组数目
UnNormalClusterCount	是	是	Int64	异常集群数
RunHostCount	是	是	Int64	运行云主机数
HostCount	是	是	Int64	云主机总数
ConsulInstanceCount	是	是	Int64	已注册实例数
PackageSpaceUsed	是	是	Uint64	程序包存储空间用量，单位字节

ContainerAdditionalResourceRequirementMap

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

被如下接口引用：DescribeResourceConfig

名称	必选	允许NULL	类型	描述
M	是	是	ContainerAdditionalResourceRequirement	Mesh 应用部署时需要的额外资源
N	是	是	ContainerAdditionalResourceRequirement	普通应用部署时需要的额外资源

Filter

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

被如下接口引用：DescribeInstances

名称	必选	允许NULL	类型	描述
Name	是	否	String	过滤条件名
Values	是	否	Array of String	过滤条件匹配值，几个条件间是或关系

ContainerAdditionalResourceRequirement

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

被如下接口引用：DescribeResourceConfig

名称	必选	允许NULL	类型	描述
Cpu	是	是	String	CPU 核数
Mem	是	是	String	内存 MiB 数

TagRouteItemV2

标签路由规则

被如下接口引用：

名称	必选	允许NULL	类型	描述
TagRouteId	否	否	String	标签路由规则项ID
TargetField	是	否	String	标签路由匹配目标字段
TargetValue	是	否	String	标签路由匹配目标取值
RouteRuleId	否	否	String	标签路由所属路由ID
SourceList	是	否	Array of TagRouteItemSourceV2	标签路由源标签列表

HealthCheckConfig

健康检查配置

被如下接口引用：CreateApplication、DescribeApplication、DescribeApplications、ModifyApplication

名称	必选	允许NULL	类型	描述
Path	否	是	String	健康检查路径

GroupsByScalableRuleIdListV2

GroupsByScalableRuleIdList

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	TotalCount
Content	是	是	Array of GroupsByScalableRuleId	Content

PropertyField

属性字段

被如下接口引用：DescribeApiDetail

名称	必选	允许NULL	类型	描述
Name	是	否	String	属性名称
Type	是	否	String	属性类型
Description	是	是	String	属性描述

TaskBatchRecordPage

任务批次翻页对象

被如下接口引用：DescribeTaskBatchHistoryRecords、DescribeTaskBatchRecords

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	总数量
Content	是	否	Array of TaskBatchRecord	任务批次翻页查询结果

TsfPageTraceService

调用链服务名列表

被如下接口引用：GetOssTraceServices、GetTraceServices

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	符合条件的总调用链服务名数量
Content	是	是	Array of String	调用链服务名列表

TsfPageVmSubTaskV2

虚拟机子任务分页信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	子任务总数目
SuccessCount	是	是	Int64	成功子任务数目
RunCount	是	是	Int64	运行中子任务数目
FailCount	是	是	Int64	失败子任务数目
Content	是	是	Array of VmSubTask	子任务列表信息

CosUploadInfoV2

cos上传所需信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
PkgId	是	是	String	无
Bucket	是	是	String	无
Region	是	是	String	无
Path	是	是	String	无
Credentials	是	否	CosCredentials	无

BusinessLogConfig

业务日志配置

被如下接口引用：DescribeBusinessLogConfig、DescribeBusinessLogConfigs、DescribeGroupBusinessLogConfigs

名称	必选	允许NULL	类型	描述
ConfigId	否	否	String	配置项ID
ConfigName	否	否	String	配置项名称
ConfigPath	否	是	String	配置项日志路径
ConfigDesc	否	是	String	配置项描述
ConfigTags	否	是	String	配置项标签
ConfigPipeline	否	是	String	配置项对应的ES管道
ConfigCreateTime	否	是	String	配置项创建时间
ConfigUpdateTime	否	是	String	配置项更新时间
ConfigSchema	否	是	BusinessLogConfigSchema	配置项解析规则
ConfigAssociatedGroups	否	是	Array of BusinesLogConfigAssociatedGroup	配置项关联部署组

DescribeSingleContainerGroups

部署组-独立菜单

被如下接口引用：DescribeSingleContainerGroups

名称	必选	允许NULL	类型	描述
GroupId	否	是	String	部署组id
GroupName	否	是	String	分组名称
CpuLimit	否	是	String	最大分配的 CPU 核数，对应 K8S limit
Server	是	是	String	镜像server
Reponame	是	是	String	镜像名，如/tsf/nginx
TagName	是	是	String	镜像版本名称
ClusterId	是	是	String	集群id
ClusterName	是	是	String	集群名称
NamespaceId	是	是	String	命名空间id
NamespaceName	是	是	String	命名空间名称
ApplicationId	是	是	String	应用名称
ApplicationName	是	是	String	应用类型
ApplicationType	是	是	String	分组创建时间
MemLimit	是	是	String	最大分配的内存 MiB 数，对应 K8S limit
MicroserviceType	是	是	String	微服务类型
ProtocolPorts	是	是	Array of ProtocolPort	端口列表
UpdateType	是	是	Int64	更新类型
UpdateIvl	是	是	Int64	更新时间间隔
AccessType	是	是	Int64	网络访问类型
CreateTime	是	是	String	创建时间
CpuRequest	是	是	String	初始分配的 CPU 核数，对应 K8S request
MemRequest	是	是	String	初始分配的内存 MiB 数，对应 K8S request
SubnetId	是	是	String	子网id
InstanceCount	是	是	Int64	实例个数
GroupResourceType	是	是	String	部署组资源类型
Envs	是	是	String	环境变量
UpdatedTime	是	是	Int64	部署组更新时间戳

TsfPageZipkinTraceInfo

调用链列表

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总条目数
Content	是	是	Array of ZipkinTraceInfo	调用链列表

CircuitBreakerApi

熔断API规则

被如下接口引用：CreateCircuitBreakerRule、DescribeCircuitBreakerRule、DescribeCircuitBreakerRules、UpdateCircuitBreakerRule

名称	必选	允许NULL	类型	描述
ApiId	否	否	String	API ID
Path	是	否	String	API PATH
Method	是	否	String	API Method
StrategyId	否	否	String	熔断策略ID

RatelimitRuleForUpdateV2

用于修改删除操作的限流规则

被如下接口引用：UpdateRatelimit

名称	必选	允许NULL	类型	描述
Id	是	否	String	规则ID
Name	否	否	String	规则名字，在一个微服务下唯一
Status	否	否	Uint64	状态 0表示启用 1表示停用
DurationSecond	否	否	Uint64	限流周期，单位秒
DurationQuota	否	否	Uint64	每周期内的限流配额
Description	否	否	String	描述
Dimensions	否	否	Array of RatelimitDimension	标签规则

GatewayNamespace

微服务网关可用的命名空间信息

被如下接口引用：DescribeAuthNamespaces

名称	必选	允许NULL	类型	描述
NamespaceId	是	是	String	命名空间主键
NamespaceCode	是	是	String	命名空间编码
NamespaceName	是	是	String	命名空间名称
NamespaceDesc	是	是	String	命名空间备注
ClusterId	是	是	String	集群ID
NamespaceResourceType	是	是	String	命名空间资源类型
NamespaceType	是	是	String	命名空间类型, DEF GLOBAL

ScalableRuleV2

ScalableRule

被如下接口引用：

名称	必选	允许NULL	类型	描述
RuleId	是	是	String	RuleId
Name	是	是	String	Name
ExpandVmCountLimit	是	是	Int64	ExpandVmCountLimit
ShrinkVmCountLimit	是	是	Int64	ShrinkVmCountLimit
GroupCount	是	是	Int64	GroupCount

TaskFlowBatchHistoryPage

批次历史分页

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	总数
Content	是	否	Array of TaskFlowBatch	分页数据

TaskRecordSimpleInfoPage

翻页查询基本任务信息列表

被如下接口引用：DescribeFlowAvailableTasks

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Uint64	总数量
Content	是	否	Array of TaskRecordSimpleInfo	基本任务信息数组

ClusterV2

集群详情

被如下接口引用：DescribeCluster、DescribeClusters

名称	必选	允许NULL	类型	描述
ClusterId	是	是	String	集群ID
ClusterName	是	是	String	集群名称
ClusterDesc	是	是	String	集群描述
ClusterType	是	是	String	集群类型
VpcId	是	是	String	集群所属私有网络ID
ClusterStatus	是	是	String	集群状态
ClusterCIDR	是	是	String	集群CIDR
ClusterTotalCpu	是	是	Float	集群总CPU，单位: 核
ClusterTotalMem	是	是	Float	集群总内存，单位: G
ClusterUsedCpu	是	是	Float	集群已使用CPU，单位: 核
ClusterUsedMem	是	是	Float	集群已使用内存，单位: G
InstanceCount	是	是	Int64	集群机器实例数量
RunInstanceCount	是	是	Int64	集群运行中的机器实例数量
NormalInstanceCount	是	是	Int64	集群正常状态的机器实例数量
DeleteFlag	是	是	Bool	删除标记：true：可以删除；false：不可删除
CreateTime	是	是	String	创建时间
UpdateTime	是	是	String	更新时间
TsfRegionId	是	是	String	集群所属TSF地域ID
TsfRegionName	是	是	String	集群所属TSF地域名称
TsfZoneId	是	是	String	集群所属TSF可用区ID
TsfZoneName	是	是	String	集群所属TSF可用区名称
DeleteFlagReason	是	是	String	集群不可删除的原因
SubnetId	是	是	String	集群所属私有网络子网ID
ClusterLimitCpu	是	是	String	集群剩余 cpu limit
ClusterLimitMem	是	是	String	集群剩余 memory limit
RunServiceInstanceCount	是	是	Int64	运行服务实例数
OperationInfo	是	是	OperationInfo	给前端的按钮控制信息
ClusterVersion	是	是	String	容器集群版本
GroupCount	是	是	Uint64	部署组总数
RunGroupCount	是	是	Uint64	运行中部署组数
StopGroupCount	是	是	Uint64	停止中部署组数
AbnormalGroupCount	是	是	Uint64	异常部署组数
ClusterRemarkName	是	是	String	集群备注名
ClusterCpuType	否	是	String	集群cpu架构
DisableProgramAuthCheck	否	是	Bool	关闭数据集校验
KuberneteApiServer	否	是	String	kuberneteApiServer
ProgramId	否	是	String	数据集id
Unbind	否	是	Bool	unbind
KuberneteNativeType	否	是	String	类型
MaxClusterServiceNum	否	是	Int64	最大服务数
KuberneteNativeSecret	否	是	String	secret
MaxNodePodNum	否	是	Int64	最大pod数

ContainGroupV2

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

被如下接口引用：

名称	必选	允许NULL	类型	描述
GroupId	否	是	String	groupId
GroupName	否	是	String	分组名称
CreateTime	否	是	String	创建时间
Server	是	是	String	镜像server
Reponame	是	是	String	镜像名，如/tsf/nginx
TagName	是	是	String	镜像版本名称
ClusterId	是	是	String	集群id
ClusterName	是	是	String	集群名称
NamespaceId	是	是	String	命名空间id
NamespaceName	是	是	String	命名空间名称
CpuRequest	是	是	String	初始分配的 CPU 核数，对应 K8S request
CpuLimit	是	是	String	最大分配的 CPU 核数，对应 K8S limit
MemRequest	是	是	String	初始分配的内存 MiB 数，对应 K8S request
MemLimit	是	是	String	最大分配的内存 MiB 数，对应 K8S limit

TsfRecordCodeResult

操作审计日志术语码返回结果

被如下接口引用：DescribeRecordCodes

名称	必选	允许NULL	类型	描述
Operations	是	否	Array of TypeCode	操作类型术语
Modules	是	否	Array of TypeCode	模块类型术语

TaskInstance

被如下接口引用：ListScalableTasks

名称	必选	允许NULL	类型	描述
Id	是	是	String	id
Status	是	是	Int64	status
Mtime	是	是	String	mtime

BusinessLog

业务日志

被如下接口引用：SearchContainerStdoutLog

名称	必选	允许NULL	类型	描述
InstanceId	是	是	String	实例ID
Content	是	是	String	日志内容
Timestamp	是	是	Uint64	日志时间戳

InvocationIndicator

服务调用监控指标

被如下接口引用：DescribeInovcationIndicators

名称	必选	允许NULL	类型	描述
InvocationQuantity	是	是	Int64	总请求数
InvocationSuccessRate	是	是	Float	请求成功率，百分比
InvocationAvgDuration	是	是	Float	请求平均耗时，单位毫秒
InvocationSuccessDistribution	是	是	Array of IndicatorCoord	成功请求数时间分布
InvocationFailedDistribution	是	是	Array of IndicatorCoord	失败请求数时间分布
InvocationStatusDistribution	是	是	Array of IndicatorCoord	状态码分布
InvocationDurationDistribution	是	是	Array of IndicatorCoord	时延分布
InvocationQuantityDistribution	是	是	Array of IndicatorCoord	并发请求次数时间分布

GroupsByScalableRuleId

被如下接口引用：DescribeScalableRuleAttributeByGroup、ListGroupsByScalableRuleId

名称	必选	允许NULL	类型	描述
ApplicationId	是	是	String	ApplicationId
ApplicationName	是	是	String	ApplicationName
GroupId	是	是	String	GroupId
GroupName	是	是	String	GroupName
Status	是	是	Int64	Status
UpdateTime	是	是	String	UpdateTime
RuleId	是	是	String	弹性伸缩规则id
ClusterId	是	是	String	集群ID
ClusterName	是	是	String	集群名称
ClusterType	是	是	String	集群类型
NamespaceId	是	是	String	命名空间ID
NamespaceName	是	是	String	命名空间名称
RuleName	是	是	String	弹性伸缩规则名

AppPkgListV2

用用的包列表

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	无
Content	是	是	Array of AppPkgInfo	无

AuthDataMap

认证数据map

被如下接口引用：DescribeSecretList

名称	必选	允许NULL	类型	描述
Key	否	否	String	键
Value	否	否	String	值

DeliveryKafkaInfo

kafka投递的topic和path的信息

被如下接口引用：CreateDeliveryConfig、UpdateDeliveryConfig

名称	必选	允许NULL	类型	描述
Topic	否	是	String	投递kafka的topic
Path	否	是	Array of String	采集日志的path

ProtocolPortsV2

端口对象

被如下接口引用：

名称	必选	允许NULL	类型	描述
Protocol	是	否	String	TCP UDP
Port	是	否	Int64	服务端口
TargetPort	是	否	Int64	容器端口
NodePort	否	是	Int64	主机端口

CosCredentialsV2

cos临时帐号信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
SessionToken	是	是	String	无
TmpAppId	是	是	String	无
TmpSecretId	是	是	String	无
TmpSecretKey	是	是	String	无
ExpiredTime	是	是	Int64	无
Domain	是	是	String	无

RecordV2

操作记录对象

被如下接口引用：DescribeRecords

名称	必选	允许NULL	类型	描述
AppId	是	是	String	账号AppId
Uin	是	是	String	账号Uin
SubAccountUin	是	是	String	账号SubAccountUin
RecordId	是	是	String	操作记录Id
ModuleType	是	是	String	模块类型
OperationType	是	是	String	操作类型
OperationResource	是	是	String	操作资源信息
OperationMsg	是	是	String	操作记录描述
OperationTime	是	是	String	操作记录时间
OperationStatus	是	是	String	操作状态
Operator	是	是	String	操作人

TsfApiListResponse

被如下接口引用：DescribeInterfaceList、DescribeMsApiList

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	数量
Content	是	是	Array of MsApiArray	API 列表

TxList

查询事务列表

被如下接口引用：DescribeTransactions

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	返回的事务数量
Content	是	是	Array of TxMainTransaction	主事务信息
Error	是	是	TxError	请求异常信息

VmTask

虚拟机操作记录

被如下接口引用：DscribeTasks

名称	必选	允许NULL	类型	描述
TaskId	是	是	String	任务Id
CreateTime	是	是	String	创建时间
TaskType	是	是	Int64	任务类型
GroupId	是	是	String	分组Id
GroupName	是	是	String	分组名称
PkgId	是	是	String	程序包Id
PkgName	是	是	String	程序包名称
PkgVersion	是	是	String	程序包版本
TaskDesc	是	是	String	任务描述
TotalCount	是	是	Int64	子任务数目
SuccessCount	是	是	Int64	成功的子任务数目
RunCount	是	是	Int64	运行中的子任务数目
FailCount	是	是	Int64	失败的子任务数目
TaskStatus	是	是	Uint64	任务的变更状态

FileConfig

文件配置项

被如下接口引用：DescribeFileConfig、DescribeFileConfigSummary、DescribeFileConfigs

名称	必选	允许NULL	类型	描述
ConfigId	否	是	String	配置项ID
ConfigName	否	是	String	配置项名称
ConfigVersion	否	是	String	配置项版本
ConfigVersionDesc	否	是	String	配置项版本描述
ConfigFileName	否	是	String	配置项文件名
ConfigFileValue	否	是	String	配置项文件内容
ConfigFileCode	否	是	String	配置项文件编码
CreationTime	否	是	String	创建时间
ApplicationId	否	是	String	配置项归属应用ID
ApplicationName	否	是	String	应用名称
DeleteFlag	否	是	Bool	删除标识
ConfigVersionCount	否	是	Int64	配置项版本数量
LastUpdateTime	否	是	String	配置项最后更新时间
ConfigFilePath	否	是	String	发布路径
ConfigPostCmd	否	是	String	后置命令
ConfigFileValueLength	否	是	Uint64	配置项文件长度

LaneGroup

泳道部署组

被如下接口引用：CreateLane、CreateLaneGroup、DeleteLaneGroup、DescribeGroupLane、DescribeLane、DescribeLaneGroupExist、DescribeLaneGroups、DescribeLanes、DisableLaneGroupEntrance、EnableLaneGroupEntrance、ModifyGroupLane

名称	必选	允许NULL	类型	描述
LaneGroupId	否	是	String	泳道部署组ID
LaneId	否	是	String	泳道ID
GroupId	是	是	String	部署组ID
GroupName	否	是	String	部署组名
ApplicationId	否	是	String	应用ID
ApplicationName	否	是	String	应用名
NamespaceId	否	是	String	命名空间ID
NamespaceName	否	是	String	命名空间名称
Entrance	是	是	Bool	是否入口应用
CreateTime	否	是	Int64	创建时间
UpdateTime	否	是	Int64	更新时间
ClusterType	否	是	String	集群类型

TxListV2

查询事务列表

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	返回的事务数量
Content	是	是	TxMainTransaction	主事务信息
Error	是	是	TxError	事务异常信息

RatelimitRuleForUpdate

用于修改删除操作的限流规则

被如下接口引用：DeleteRatelimit、DisableRatelimit、EnableRatelimit

名称	必选	允许NULL	类型	描述
Id	是	否	String	规则ID
Name	否	否	String	规则名字，在一个微服务下唯一
Status	否	否	Uint64	状态 0表示启用 1表示停用
DurationSecond	否	否	Uint64	限流周期，单位秒
DurationQuota	否	否	Uint64	每周期内的限流配额
Description	否	否	String	描述

NamespaceWrong

命名空间

被如下接口引用：

名称	必选	允许NULL	类型	描述
NamespaceId	是	是	String	命名空间ID
NamespaceCode	是	是	String	命名空间编码
NamespaceName	是	是	String	命名空间名称
NamespaceDesc	是	是	String	命名空间描述
ClusterId	是	是	String	集群ID
ClusterName	是	是	String	集群名称
ClusterType	是	是	String	集群类型
IsDefault	是	是	String	默认命名空间
NamespaceStatus	是	是	String	命名空间状态
DeleteFlag	是	是	Bool	删除标识
CreateTime	是	是	String	创建时间
UpdateTime	是	是	String	更新时间

ScalableTaskResultV2

ScalableTaskResult

被如下接口引用：

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	TotalCount
Content	是	是	Array of ScalableTask	Content

CommonGroupAttribute

通用部署组额外属性

被如下接口引用：DescribeCommonGroupAttribute

名称	必选	允许NULL	类型	描述
Status	是	是	String	部署组状态
InstanceCount	是	是	Int64	部署组实例数

ContainGroupResult

部署组列表（应用下钻）

被如下接口引用：DescribeContainerGroups

名称	必选	允许NULL	类型	描述
Content	是	是	Array of ContainGroup	部署组列表
TotalCount	是	否	Int64	总记录数