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

数据结构

最近更新时间: 2026-10-11 00:12:05

OverviewClusterResourceUsageResult

集群概览页信息的分页包装类

被如下接口引用：DescribeClusterUsage

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	总数目示例值：
Content	是	否	Array of OverviewClusterResourceUsage	数据示例值：查看

TaskRecord

任务定义

被如下接口引用：DescribeTaskDetail、DescribeTaskRecords

名称	必选	允许NULL	类型	描述
TaskContent	否	否	String	任务内容，长度限制65535字节示例值：
TaskRule	是	否	TaskRule	触发规则示例值：查看
SuccessOperator	是	是	String	判断任务成功的操作符示例值：
TaskArgument	是	是	String	任务参数，长度限制10000个字符示例值：
TaskName	是	否	String	任务名称示例值：
RetryCount	否	是	Int64	重试次数示例值：
BelongFlowIds	是	是	Array of String	所属工作流ID 示例值：
TriggerType	是	是	String	触发类型，一共3种类型，WorkFlow：工作流触发，Cron：定时触发，FixRate：周期触发示例值：
ExecuteType	是	否	String	任务执行方式，unicast：随机单节点执行，broadcast：广播执行，shard：分片执行示例值：
RetryInterval	否	是	Int64	重试间隔，单位：毫秒。示例值：
SuccessRatio	是	是	Int64	判断任务成功的阈值示例值：
ShardCount	是	是	Int64	分片数量示例值：
AdvanceSettings	是	是	AdvanceSettings	高级设置示例值：查看
ShardArguments	是	是	Array of ShardArgument	分片参数示例值：查看
TaskLogId	是	是	String	任务历史ID 示例值：
TaskType	是	否	String	任务类型示例值：
GroupId	否	否	String	分组ID 示例值：
TimeOut	是	否	Int64	超时时间，单位：毫秒。示例值：
TaskState	是	否	String	任务启用状态。一共2种状态可选，ENABLED：启用，DISABLED：停用示例值：
TaskId	是	否	String	任务ID 示例值：

CronRule

定时弹性扩缩容规则描述

被如下接口引用：CreateScalableRule、CreateScalableRuleWithDetailResp、DescribeScalableRuleAttribute、ModifyScalableRule

名称	必选	允许NULL	类型	描述
Period	是	是	String	策略周期，三个范围，第一个是天，第二个是月，第三个是周，中间用空格隔开, 例子：（每天） 0-3 （每周日到周三） 1,11,21 （每个月1号，11号，21号）示例值：
Schedules	是	是	Array of CronSchedule	定时伸缩策略详情列表示例值：查看
Priority	是	是	Uint64	策略优先级，值越大优先级越高，0为最小值示例值：

TsfPageApplication

应用分页信息

被如下接口引用：DescribeApplications

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	应用总数目示例值：
Content	是	是	Array of ApplicationForPage	应用信息列表示例值：查看
SpecTotalCount	否	否	Int64	获取部署组实例列表返回的原始批次个数示例值：

SidecarMetrics

sidecar监控指标

被如下接口引用：DescribeSidecarMetrics

名称	必选	允许NULL	类型	描述
StartTime	否	是	Datetime_iso	统计开始时间示例值：
DownstreamRequestCount	否	是	Int64	Downstream总请求数示例值：
DownstreamFailureCount	否	是	Int64	Downstream总失败数示例值：
UpstreamRequestCount	否	是	Int64	Upstream总请求数示例值：
UpstreamFailureCount	否	是	Int64	Upstream总失败数示例值：
Allocated	否	是	String	当前消耗的内存示例值：

KubeInjectConfig

容器轻量化配置

被如下接口引用：DescribeKubeInjectConfig

名称	必选	允许NULL	类型	描述
AgentCpuRequest	是	是	String	AgentCpuRequest值示例值：
AgentCpuLimit	是	是	String	AgentCpuLimit值示例值：
AgentMemRequest	是	是	String	AgentMemRequest值示例值：
AgentMemLimit	是	是	String	AgentMemLimit值示例值：
EnableByDefault	是	是	Bool	EnableByDefault值示例值：
DefaultMicroserviceType	是	是	String	DefaultMicroserviceType值示例值：
ApmInstanceId	否	是	String	ApmInstanceId 示例值：
EnableGovernance	否	是	Bool	EnableGovernance 示例值：
MicroserviceType	否	是	String	MicroserviceType 示例值：
ServiceGovernanceConfig	否	是	String	ServiceGovernanceConfig 示例值：
ExclusiveInstanceNamespaceId	否	是	String	ExclusiveInstanceNamespaceId 示例值：
AgentImage	否	是	String	AgentImage 示例值：
DeleteCleanup	否	是	String	DeleteCleanup 示例值：
FrameworkType	否	是	String	FrameworkType 示例值：
AgentDisable	否	是	Bool	AgentDisable 示例值：

ContainerVolumeOption

容器卷挂载信息

被如下接口引用：DescribeContainerVolumeOptions

名称	必选	允许NULL	类型	描述
Secret	否	否	Array of VolumeItem	无示例值：查看
PersistentVolumeClaim	否	否	Array of VolumeItem	无示例值：查看
ConfigMap	否	否	Array of VolumeItem	无示例值：查看

TsfApiListResponse

被如下接口引用：DescribeInterfaceList、DescribeMsApiList

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	数量示例值：
Content	是	是	Array of MsApiArray	API 列表示例值：查看

WarmupSetting

预热配置

被如下接口引用：DeployApplication、DeployContainerApplication、DeployContainerGroup、DeployGroup、DescribeContainerGroupDeployInfo、DescribeGroup、DescribeGroups、DescribeVmGroupRevisionInfo

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

ResourceStatus

模块资源的使用情况

被如下接口引用：DescribeResourceUsageRate

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

ESAuthInfo

es鉴权信息

被如下接口引用：GetApmEsAuthInfo

名称	必选	允许NULL	类型	描述
EsUserName	否	是	String	es用户名示例值：
EsPassWord	否	是	String	es用户密码示例值：
EsAuthTime	否	否	String	es用户生成时间示例值：

TsfPageAppIdEntity

TsfPage，当前租户ID

被如下接口引用：DescribeCurrentAppId

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	TsfPageAppIdEntity 示例值：
Content	是	否	Array of AppIdEntity	租户ID列表示例值：查看

DeployContainerGroupByPlainYamlResult

DeployContainerGroupByPlainYaml 的结果

被如下接口引用：DeployContainerGroupByPlainYaml

名称	必选	允许NULL	类型	描述
Success	是	是	Bool	部署是否成功示例值：

GetClusterLimitResourceResult

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

被如下接口引用：GetClusterLimitResource

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

ApmInstanceDetail

apm实例信息

被如下接口引用：DescribeApmInstances

名称	必选	允许NULL	类型	描述
ApplicationCount	是	是	Int64	接入应用数量示例值：
TodaySpanCount	是	是	Int64	今日上报量示例值：
InstanceId	是	否	String	业务系统Id 示例值：
InstanceName	是	是	String	业务系统名示例值：
BillingMode	是	是	String	计费模式枚举：On， Off 只有Default业务系统需要返回示例值：
Status	是	是	Int64	状态 0:No use 1:初始化 2:正常 3:删除 4:限流 5:欠费示例值：

KubeDeployment

容器轻量化Deployment

被如下接口引用：DescribeKubeDeployments

名称	必选	允许NULL	类型	描述
Imported	是	是	Bool	Imported值示例值：
ApplicationName	是	是	String	ApplicationName值示例值：
Name	是	是	String	Name值示例值：
Status	是	是	String	Status值示例值：

MetricDimensionValue

指标维度多值匹配

被如下接口引用：DescribeGeneralMetricDataDimension、DescribeInvocationMetricDataDimension、DescribeInvocationMetricDataPoint、DescribeStatistics

名称	必选	允许NULL	类型	描述
Value	是	否	Array of String	维度值示例值：
Name	是	否	String	维度名示例值：

TsfPageMicroserviceGroup

微服务下部署组列表

被如下接口引用：DescribeMicroserviceGroups

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	数据总数示例值：
Content	是	是	Array of MicroserviceGroup	翻页数据示例值：查看

UnitRouteRuleItem

路由规则内容

被如下接口引用：DescribeUnitRouteConfig

名称	必选	允许NULL	类型	描述
Name	否	否	String	规则项名称示例值：
UnitRuleTagList	否	否	Array of UnitRouteRuleTag	标签匹配示例值：查看
Relationship	否	否	String	标签逻辑关系，支持 AND/OR 示例值：
DestUnitId	否	否	String	目标单元id 示例值：
DestUnitName	否	是	String	目标单元名称示例值：
CloudSpaceName	否	否	String	云空间名称示例值：

DtsGroup

事务分组

被如下接口引用：DescribeDtsGroups

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

JvmLockDetail

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

被如下接口引用：RunJvmDeadLockCheck

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

TsfConfig

TSF配置

被如下接口引用：DescribeResourceTsfConfig

名称	必选	允许NULL	类型	描述
TsfId	否	是	String	TSFID标识示例值：
TsfName	否	是	String	TSF名称示例值：
Region	否	是	String	地域示例值：
ConsulAccessInfo	否	是	ConsulAccessInfo	注册中心配置信息示例值：查看
CtsdbInfo	否	是	CtsdbInfo	CTSDB配置信息示例值：查看

TsfPageSimpleNamespace

分页的命名空间里表，含命名空间 ID ，命名空间名称和类型

被如下接口引用：DescribeGeneralMetricDataDimension

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总数示例值：
Content	是	是	SimpleNamespace	元数据列表示例值：查看

ListAlarmPoliciesResult

被如下接口引用：ListAlarmPolicies

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	TotalCount 示例值：
Content	是	是	Array of AlarmPolicyResult	Content 示例值：查看

ImageInfo

镜像信息

被如下接口引用：DescribeImages

名称	必选	允许NULL	类型	描述
ImageName	是	是	String	ImageName 示例值：
ImageDesc	是	是	String	ImageDesc 示例值：
CreateTime	是	是	String	CreateTime 示例值：
LoginName	是	是	String	LoginName 示例值：
ImageId	是	是	String	ImageId 示例值：
OsName	是	是	String	OsName 示例值：
ImageSize	是	是	Int64	ImageSize 示例值：
ImageType	是	是	String	ImageType 示例值：
OsCustomizeType	否	是	String	OsCustomizeType 示例值：
ImageCpuType	否	是	String	ImageCpuType 示例值：

LaneRules

泳道规则分页查询

被如下接口引用：DescribeLaneRules

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

GatewayInstance

网关实体

被如下接口引用：DescribeGatewayInstance、DescribeGatewayInstances、DescribeGatewayInstancesByApplication、DescribeGatewayInstancesByMultiCloud

名称	必选	允许NULL	类型	描述
ServiceId	是	是	String	微服务ID 示例值： ms-67c57847d4
NamespaceId	是	是	String	命名空间ID 示例值： namespace-96a79v5b
Type	是	是	String	网关实例类型：单元化(unit)/非单元化网关(none) 示例值： none
ServiceIdList	否	是	String	微服务ID列表示例值： ["sid-1sgfsd3"]
CreatedTime	否	是	String	创建时间示例值： 2026-01-01 00:00:00
ProgramIdList	否	是	String	数据集ID列表示例值： "prg-s2r22dgs"
AppId	否	是	String	租户ID 示例值： 1255000100
Id	是	是	String	网关实体ID 示例值： gw-ins-s24dvfasd
ConsulInstanceCount	是	是	Int64	注册中心在线节点数示例值： 10
IdList	否	是	Array of String	网关实体ID列表示例值： ["id-1sgs33"]
SubAccountUin	否	是	String	子账号ID 示例值： 20250908110011
MultiCloudTsfId	否	是	String	忽略，预留字段示例值： "sss34dgsdfg"
UpdatedTime	否	是	String	修改时间示例值： 2026-01-01 00:00:00
MultiCloudDisableDeleted	否	是	Bool	忽略，预留字段示例值： false
ServiceName	是	是	String	微服务名示例值： service-naes2s23name
NamespaceName	是	是	String	命名空间名示例值： name-ns
Uin	否	是	String	主账号ID 示例值： 20250908110011
MultiCloudStatus	否	是	String	是否禁用绑定(超云) 示例值： ins-gw0s2sf
MultiCloudStatusMsg	否	是	String	禁用提示信息(超云) 示例值： ins-gw0s2sfss2
RouteScope	否	是	String	转发范围LOCAL (同城) REMOTE (异地) LOCAL_REMOTE (支持同城及异地) 示例值： ALL
MultiCloudDisableReason	否	是	String	禁用删除理由示例值：网关已绑定分组，请解绑分组后重试

TsfPageRouteAffinity

TSF就近访问列表对象

被如下接口引用：DescribeNamespaceAffinities

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

LicenseDuration

被如下接口引用：DescribeLicenseApplications

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

GroupInstanceUnified

DescribeGroupInstancesUnified 的单个结果

被如下接口引用：DescribeGroupInstancesUnified

名称	必选	允许NULL	类型	描述
ClusterType	是	是	String	集群类型示例值：
ClusterId	是	是	String	实例的 cluster id 示例值：
ApplicationId	是	是	String	实例的 application id 示例值：
InstanceName	是	是	String	实例的名字示例值：
NamespaceName	是	是	String	命名空间名称示例值：
GroupName	是	是	String	部署组名称示例值：
AppId	是	是	String	实例的 appid 示例值：
NamespaceId	是	是	String	实例的 namespace id 示例值：
GroupId	是	是	String	实例的 group id 示例值：
InstanceId	是	是	String	实例的 id 示例值：
ApplicationName	是	是	String	应用名称示例值：

AddInstanceResult

添加实例到集群的结果

被如下接口引用：AddClusterInstances

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

OverviewClusterResourceUsage

集群概览页信息

被如下接口引用：DescribeClusterUsage

名称	必选	允许NULL	类型	描述
ClusterId	是	否	String	集群ID 示例值： cluster-qwexxx
ClusterName	是	否	String	集群名示例值： cls-demo
ClusterTotalCpu	是	否	Float	集群总 CPU 示例值： 10
ClusterUsedCpu	是	否	Float	集群已使用 CPU 示例值： 9
ClusterTotalMem	是	否	Float	集群总内存示例值： 5000
ClusterUsedMem	是	否	Float	集群已使用内存示例值： 3000
MemRate	否	是	Float	集群MEM利用率示例值： 0.40
CpuRate	否	是	Float	集群CPU利用率示例值： 0.50

UnitRouteRule

单元化路由规则

被如下接口引用：CreateAndReleaseUnitRouteConfig

名称	必选	允许NULL	类型	描述
RuleId	否	否	String	规则id 示例值：
RuleName	否	否	String	规则名称示例值：
RuleDescription	否	否	String	规则描述示例值：
RuleConfigs	否	否	Array of RuleConfig	规则内容示例值：查看
CustomerIdModValue	否	否	String	客户号模除值示例值：
UpdatedTime	否	否	String	更新时间戳示例值：
UpdatedShowTime	否	否	String	更新时间，由UpdatedTime转换而来，用于前端展示示例值：
RouteElementConfig	否	否	RouterIdentifier	路由要素配置示例值：查看
DataAppId	否	否	String	数据所属 appId 示例值：
DataUin	否	否	String	数据所属 uin 示例值：
DataSubAccountUin	否	否	String	数据所属 sub uin 示例值：

TsfPageInvocationStatisticsV2

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

被如下接口引用：DescribeInvocationStatistics

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

AvailableZoneScatterScheduleRule

打散调度规则

被如下接口引用：DeployContainerApplication、DeployContainerGroup、DescribeContainerGroupDeployInfo

名称	必选	允许NULL	类型	描述
ScatterDimension	否	否	String	- 示例值：
MaxUnbalanceQuantity	否	否	Int64	- 示例值：
IsForceSchedule	否	否	Bool	- 示例值：
Paths	否	否	Array of CommonOption	- 示例值：查看

ReleaseTemplate

发布单模板

被如下接口引用：DescribeReleaseTemplate

名称	必选	允许NULL	类型	描述
TemplateType	否	是	String	发布单模板类型示例值：
BatchTemplate	否	是	BatchTemplate	分批发布示例值：查看
BlueGreenTemplate	否	是	BlueGreenTemplate	蓝绿发布示例值：查看

CheckConfigResult

查询是否支持配置中心结果

被如下接口引用：CheckConfigCenterSupported

名称	必选	允许NULL	类型	描述
Supported	否	是	Bool	true 支持，false 不支持示例值：
RegionId	否	是	String	地域id 示例值：

RouteDestItemV2

服务路由目标匹配项

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

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

ManagerJobInfo

运营端任务管理

被如下接口引用：ListManagerJobInfo

名称	必选	允许NULL	类型	描述
JobDesc	是	是	String	无示例值：
ScheduleConf	是	是	String	无示例值：
ExecutorFailRetryCount	是	是	Int64	无示例值：
TriggerStatus	是	是	Int64	无示例值：
TriggerNextTime	是	是	Int64	无示例值：
ModuleName	是	是	String	无示例值：
Id	是	是	Int64	无示例值：
ExecutorParam	是	是	String	无示例值：
ExecutorTimeout	是	是	Int64	无示例值：
GlueSource	是	是	String	无示例值：

GroupResourceConfig

部署组相关的参数配置

被如下接口引用：DescribeResourceConfig

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

TxRetry

事务重试接口出参

被如下接口引用：RetryTransaction

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

ClsTopicRsp

日志集返回结果

被如下接口引用：DescribeClsTopics

名称	必选	允许NULL	类型	描述
Topics	否	是	Array of TopicInfo	列表示例值：查看
TotalCount	否	是	Int64	数字示例值：
Error	否	是	CloudApiV3Error	返回错误信息示例值：查看

TsfDescribeLoadBalancersResult

查询负载均衡列表返回数据结构

被如下接口引用：DescribeLoadBalancers

名称	必选	允许NULL	类型	描述
LoadBalancers	否	否	Array of TsfLoadBalancerDetail	查询负载均衡列表返回结果示例值：查看

VolumeMountInfo

容器卷挂载点信息

被如下接口引用：DeployContainerApplication、DeployContainerGroup、DescribeContainerGroupDeployInfo

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

ServiceGovernanceConfig

注册配置治理信息

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

名称	必选	允许NULL	类型	描述
EnableGovernance	否	否	Bool	是否开启服务注册治理示例值：
GovernanceType	否	否	String	服务治理类型（枚举：SHARE表示共享型、EXCLUSIVE表示独占型）示例值：
ExclusiveInstances	否	是	Array of ExclusiveInstance	独享实例列表示例值：查看

BatchGroup

批次部署组

被如下接口引用：DescribeReleaseTemplate、ModifyReleaseTemplate

名称	必选	允许NULL	类型	描述
Groups	是	是	Array of ReleaseGroup	批次内的部署组列表示例值：查看
UnitId	否	是	String	单元ID 示例值： consumer-demo
UnitType	否	是	String	单元类型示例值： consumer-demo

GraphEdgeV2

依赖拓扑图边

被如下接口引用：GetOssTopologyGraph、GetTopologyGraph

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

PkgInfo

包信息

被如下接口引用：DescribePkgs、ListPkg

名称	必选	允许NULL	类型	描述
PkgId	是	是	String	程序包ID 示例值： pkg-123x
PkgVersion	是	是	String	程序包版本示例值： 202601011121
PkgPubStatus	是	是	Int64	程序包状态示例值： 0
PkgBindInfo	是	是	Array of PkgBind	程序包关联关系示例值：查看
PkgName	是	是	String	程序包名示例值： pkg-xxx
PkgType	是	是	String	程序包类型示例值： jar
PkgDesc	是	是	String	程序包描述示例值： xxxx
UploadTime	是	是	String	上传时间示例值： 2026-03-28
Md5	是	是	String	程序包MD5 示例值： 75af2e71a5ba19115acff3d5f6800000
PkgSdkVersion	否	是	String	程序包sdk版本示例值： 2.1.0.0-2024.0.2-RC2
UseOT	否	是	String	是否使用OT 示例值： YES
OtAgentVersion	否	是	String	OT 的版本示例值： 1.15
RepositoryId	否	是	String	仓库id 示例值： repo-xx
RepositoryType	否	是	String	仓库类型示例值： default
RepositoryName	否	是	String	仓库名称示例值： test

EventCategoryResult

事件概览结果

被如下接口引用：DescribeEventCategoryName、DescribeOverviewEvent

名称	必选	允许NULL	类型	描述
Category	是	否	String	事件类型示例值：
Count	否	是	Int64	数量示例值：
Names	否	是	Array of TsfEventAttribute	事件名列表示例值：查看

OverviewGroupResourceUsage

部署组统计信息

被如下接口引用：DescribeGroupResourceUsage

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

OverviewConfig

概览页配置

被如下接口引用：DescribeResourceUsageConfig

名称	必选	允许NULL	类型	描述
ClusterThreshold	是	否	Uint64	集群显示阈值示例值： 80%
AppId	否	是	String	appId 示例值： appId

GroupInfo

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

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

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

JavaInstance

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

被如下接口引用：DescribeJavaInstance

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

GatewayConfig

TSF Envoy网关服务配置

被如下接口引用：DeployContainerApplication、DeployContainerGroup、DeployGroup、DescribeContainerGroupDeployInfo、DescribeGroup、DescribeGroups、DescribeVmGroupRevisionInfo

名称	必选	允许NULL	类型	描述
Name	是	是	String	服务名称示例值：
Port	是	是	Int64	服务端口示例值：
Protocol	是	是	String	端口协议, http或https 示例值：
KeyPath	否	是	String	SSL秘钥文件路径, https类型的协议适用此参数示例值：
CertPath	否	是	String	SSL证书文件路径, https类型的协议适用此参数示例值：

MetricSummary

网关监控指标总览

被如下接口引用：DescribeGatewayMonitorDetails

名称	必选	允许NULL	类型	描述
AverageValue	否	否	MetricStatistic	统计指标平均值示例值：查看
MetricData	否	否	Array of MetricDataCurve	网关指标监控数据曲线集合示例值：查看
AverageValues	否	否	MetricStatistic	统计指标平均值示例值：查看
GatewayMetricData	否	否	Array of MetricDataCurve	网关指标监控数据曲线集合示例值：查看

VmInstanceRevisionInfo

虚拟机部署组历史版本的机器实例

被如下接口引用：DescribeVmGroupRevisionInfo

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

MultipartPkg

分片包详情

被如下接口引用：DownloadMultipartPkg

名称	必选	允许NULL	类型	描述
PkgId	是	否	String	程序包ID 示例值： pkg-a54e0000
FileSeg	是	否	Uint64	当前分片示例值： 1
FileSegments	是	否	Uint64	总分片数示例值： 8
SegmentSize	是	否	Uint64	每个分片的大小 (字节数) 示例值： 10240
Md5	是	否	String	文件的MD5 示例值： 2a0fb8b05aa8570fab5361cd59c90000
Size	是	否	Uint64	文件大小（总字节数）示例值： 81920
File	是	否	String	文件编码数据 (@为首，表示base64编码) 示例值： 0F0012345

ZipkinAnnotationV2

调用链Span注解

被如下接口引用：GetOssTraceSpans

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

Condition

路由规则条件

被如下接口引用：CreateAndReleaseUnitRouteConfig

名称	必选	允许NULL	类型	描述
Key	否	否	String	标签名示例值：
Operator	否	否	String	匹配条件，支持IN/NOT_IN/EQUAL/NOT_EQUAL/REGEX/RANGE 示例值：
Value	否	否	String	值示例值：

PolicyItem

tsf-privilege模块，策略项

被如下接口引用：CreatePolicyDocument

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

ApiResponseDescr

API 响应的参数结构描述

被如下接口引用：DescribeApiDetail

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

CronSchedule

定时策略描述

被如下接口引用：CreateScalableRule、CreateScalableRuleWithDetailResp、DescribeScalableRuleAttribute、ModifyScalableRule

名称	必选	允许NULL	类型	描述
StartAt	是	是	String	触发时间，小时分钟，用:分割, 例如 00:00（零点零分触发）示例值：
MinReplicas	是	是	Uint64	目标最小实例数, 取值为正整数示例值：
MaxReplicas	是	是	Uint64	目标最大实例数, 取值为正整数示例值：

ImportGroupApiVo

网关批量导入API失败列表

被如下接口引用：ImportGroupApis

名称	必选	允许NULL	类型	描述
ImportErrorGroupApiList	否	是	Array of ImportErrorGroupApi	导入结果明细示例值：查看
ImportStatus	是	是	Bool	导入结果示例值：

ModulesResult

被如下接口引用：ListTsfModulesDetail

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

LicenseProduct

被如下接口引用：DescribeLicenseApplications

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

SecretKeyInfo

微服务网关密钥信息

被如下接口引用：ChangeSecretStatus、DescribeGroupSecrets

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

RouteTagV2

服务路由规则项匹配条件

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

名称	必选	允许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 示例值：

FilebeatConfigPage

filebeat config 配置分页

被如下接口引用：DescribeFilebeatConfigPage

名称	必选	允许NULL	类型	描述
Content	是	是	Array of FilebeatConfig	配置列表示例值：查看
TotalCount	是	是	Uint64	总数示例值：

ScalableTaskResult

被如下接口引用：ListScalableTasks

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	TotalCount 示例值：
Content	是	是	Array of ScalableTask	Content 示例值：查看

ReleasePipeline

发布单流水线信息

被如下接口引用：DescribeReleasePipeline

名称	必选	允许NULL	类型	描述
Stages	否	否	Array of ReleaseStage	阶段数组示例值：查看
Uin	否	否	String	主帐号示例值：
SubAccountUin	否	否	String	操作人子帐号示例值：
Nickname	否	否	String	操作人昵称示例值：

InstanceComponent

tsf-agent 纳管的组件信息

被如下接口引用：DescribeGroupInstanceComponents

名称	必选	允许NULL	类型	描述
Name	否	是	String	组件名称示例值：
Version	否	是	String	组件版本示例值：
Status	否	是	String	存活状态正常；异常示例值：
ReadinessStatus	否	是	String	就绪状态正常；异常示例值：

OverviewLicenseResourceUsage

license相关信息概览

被如下接口引用：DescribeLicenseInfo

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

ApiVersionArray

API版本数组

被如下接口引用：DescribeApiVersions、DescribeDownloadableApiVersions

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

ReleasePipelineTask

发布单流水任务

被如下接口引用：DescribeReleasePipelineTask

名称	必选	允许NULL	类型	描述
Task	否	是	ReleaseTask	任务详情示例值：查看

AppPkgInfo

应用的包信息

被如下接口引用：ListAppPkg

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

PortsResult

被如下接口引用：CreateServiceInstance、ListTsfModuleInstancePorts、ListTsfModulesDetail

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

ContainerGroupDetail

容器部署组详情

被如下接口引用：DescribeContainerGroupDetail

名称	必选	允许NULL	类型	描述
Server	是	是	String	镜像server 示例值： xxx.test.com
Alias	否	是	String	别名示例值： group-alias
ApplicationType	是	是	String	应用类型示例值： C
UpdateType	是	是	Int64	更新方式：0:快速更新 1:滚动更新示例值： 0
UpdateIvl	是	是	Int64	更新间隔,单位秒示例值： 10
MemRequest	是	是	String	初始分配的内存 MiB 数，对应 K8S request 示例值： 100
IsNotEqualServiceConfig	否	是	Bool	是否不等于ServiceConfig 示例值： false
GroupId	是	是	String	部署组ID 示例值： group-qwexdeee
ClusterId	是	是	String	集群ID 示例值： cls-6a79x94v
LbIp	是	是	String	负载均衡ip 示例值： 10.20.13.1
ApplicationName	是	是	String	应用名称示例值： java-service
GroupResourceType	是	是	String	部署组资源类型示例值： C
RepoName	否	是	String	仓库名示例值： /tsf/nginx
InstanceNum	是	是	Int64	实例总数示例值： 1
CreateTime	是	是	String	创建时间示例值： 2020-11-21 09:33:23
NamespaceName	是	是	String	命名空间名称示例值： default
InstanceCount	是	是	Uint64	部署组实例个数示例值： 1
GroupName	是	是	String	分组名称示例值： java-group
NamespaceId	是	是	String	命名空间ID 示例值： namespace-6a79x94v
ApplicationId	是	是	String	应用ID 示例值： application-6a79x94v
ProtocolPorts	是	是	Array of ProtocolPort	端口数组对象示例值：查看
TagName	是	是	String	镜像版本名称示例值： latest
ClusterName	是	是	String	集群名称示例值： k8s-cls
NodePort	是	是	Int64	NodePort端口，只有公网和NodePort访问方式才有值示例值： 30021
CpuLimit	是	是	String	最大分配的 CPU 核数，对应 K8S limit 示例值： 2
AccessType	是	是	Uint64	0:公网 1:集群内访问 2：NodePort 示例值： 0
CpuRequest	是	是	String	初始分配的 CPU 核数，对应 K8S request 示例值： 1
SubnetId	是	是	String	子网id 示例值： subnet-6a79x94v
MemLimit	是	是	String	最大分配的内存 MiB 数，对应 K8S limit 示例值： 256
Envs	是	是	Array of Env	环境变量数组对象示例值：查看
Message	是	是	String	pod错误信息描述示例值： this is a msg
MicroserviceType	是	是	String	服务类型示例值： DEF
MaxSurge	否	是	String	kubernetes滚动更新策略的MaxSurge参数示例值： 25%
MaxUnavailable	否	是	String	kubernetes滚动更新策略的MaxUnavailable参数示例值： 25%
HealthCheckSettings	是	是	HealthCheckSettings	部署组健康检查设置示例值：查看
Reponame	是	是	String	镜像名，如/tsf/nginx 示例值： /tsf/nginx
ClusterIp	是	是	String	Service ip 示例值： 10.19.102.1
Status	是	是	String	部署组状态示例值： Running
UpdatedTime	是	是	Int64	部署组更新时间戳示例值： 1762890382
AllowPlainYamlDeploy	否	是	Bool	允许PlainYamlDeploy 示例值： false
CurrentNum	是	是	Int64	已启动实例总数示例值：
UnitId	否	是	String	单元ID 示例值：
LbDns	否	是	String	负载均衡的DNS地址示例值：
EnabledUnit	否	是	Bool	是否开启单元化示例值：
UnitName	否	是	String	单元名示例值：
BusinessSystemName	否	是	String	无示例值：
BusinessSystemId	否	是	String	无示例值：
K8sNamespaceName	否	是	String	无示例值：
KubeInjectEnable	否	是	Bool	该部署组是否开启了"容器轻量化"功能示例值： false

MethodDistData

DescribeThreadDump 接口出参封装

被如下接口引用：DescribeThreadDump

名称	必选	允许NULL	类型	描述
MethodId	是	否	String	函数ID字串示例值：
MethodName	是	否	String	函数名称示例值：
Count	是	否	Int64	线程个数示例值：

ImageRepository

镜像仓库

被如下接口引用：DescribeImageRepository、ImageGetRepositoryList

名称	必选	允许NULL	类型	描述
ApplicationNameReal	是	是	String	ApplicationName值示例值：
IsPublic	否	是	Int64	是否公共,1:公有,0:私有示例值：
PullCount	是	是	Int64	拉取次数示例值：
CreationTime	是	是	String	创建时间示例值：
TcrBindingId	是	是	Int64	TcrBindingId值示例值：
CreateMode	否	否	String	创建方式：manual
RepoName	否	否	String	仓库名，等同reponame字段示例值：
Reponame	是	是	String	仓库名,含命名空间,如tsf/nginx 示例值：
Repotype	否	是	String	仓库类型示例值：
TagCount	是	是	Int64	镜像版本数示例值：
RepoType	否	否	String	仓库类型示例值：
IsUserFavor	是	是	Bool	是否被用户收藏。true：是，false：否示例值：
Description	是	是	String	描述内容示例值：
TcrRepoInfo	是	是	TcrRepoInfo	TcrRepoInfo值示例值：查看
ApplicationName	是	是	ScalableRule	ApplicationName值（废弃）示例值：查看
Public	否	是	Int64	是否公共,1:公有,0:私有示例值：
IsQcloudOfficial	是	是	Bool	是否是云平台官方仓库。是否是云平台官方仓库。true：是，false：否示例值：
FavorCount	是	是	Int64	被所有用户收藏次数示例值：
UpdateTime	是	是	String	更新时间示例值：
ApplicationId	是	是	String	applicationid值示例值：

ViewInfo

视图信息

被如下接口引用：DescribeViews

名称	必选	允许NULL	类型	描述
ViewId	是	是	String	视图id 示例值：
NamespaceInfos	是	是	Array of NamespaceInfos	命名空间信息示例值：查看
ViewName	是	是	String	视图名称示例值：

GroupUnitInfo

部署组单元信息

被如下接口引用：DescribeGroupUnitInfo

名称	必选	允许NULL	类型	描述
EnabledUnit	否	否	Bool	是否开启单元化示例值： false
UnitId	否	是	String	单元 id 示例值： s001
UnitName	否	是	String	单元名称示例值： unit-name
BusinessSystemId	否	是	String	业务系统 id 示例值： consumer-demo
BusinessSystemName	否	是	String	业务系统名称示例值： consumer-demo
UnitEnvType	否	是	String	单元环境类型示例值： prod
UnitType	否	是	String	单元类型示例值： global

ZipkinBinaryAnnotationV2

调用链Span二进制注解

被如下接口引用：GetOssTraceSpans

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

ImportPathRewriteVO

导入重定向配置出参

被如下接口引用：ImportPathRewrites

名称	必选	允许NULL	类型	描述
ImportStatus	是	是	Bool	导入状态示例值：
ErrorRegexList	是	是	Array of ImportErrorRegex	导入失败的配置示例值：查看

ThreadPicture

jvm监控数据线程数据封装

被如下接口引用：DescribeJvmMonitor

名称	必选	允许NULL	类型	描述
ThreadCount	是	否	Array of CurvePoint	总线程数示例值：查看
ThreadActive	是	否	Array of CurvePoint	活跃线程数示例值：查看
DeamonThreadCount	是	否	Array of CurvePoint	守护线程数拼写错误，废弃示例值：查看
DaemonThreadCount	否	否	Array of CurvePoint	守护线程数示例值：查看

MeshLog

mesh 组件日志

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

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

MonitorOverview

监控概览对象

被如下接口引用：DescribeGatewayMonitorOverview

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

LicenseFunction

被如下接口引用：DescribeLicenseApplications

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

TsfPageZipkinSpanInfoV2

调用链Span列表

被如下接口引用：GetOssTraceSpans

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

TsfPageZipkinTraceInfoV2

调用链列表

被如下接口引用：SearchOssTrace、SearchTrace

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

PathRewritePage

路径重写翻页对象

被如下接口引用：DescribePathRewrites

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

EventSort

事件排序器

被如下接口引用：DescribeEventDetail、DescribeEventStatistics

名称	必选	允许NULL	类型	描述
OrderBy	是	否	String	排序字段示例值：
OrderType	否	否	Int64	排序方式。ASC: 0，DESC: 1。默认为 1 示例值：
OrderIndex	否	否	Int64	排序顺序，越小权重越大。最小为1，表示第一个排序的字段示例值：

ManagerJobLogPage

运营端任务日志页

被如下接口引用：ListManagerJobLog

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	无示例值：
Content	是	是	Array of ManagerJobLog	无示例值：查看

TsfPageCluster

Tsf分页集群对象

被如下接口引用：DescribeSimpleClusters

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

HealthCheckSettings

健康检查参数

被如下接口引用：DeployApplication、DeployContainerApplication、DeployContainerGroup、DeployGroup、DescribeContainerGroupAttribute、DescribeContainerGroupDeployInfo、DescribeContainerGroupDetail、DescribeGroup、DescribeGroupAttribute、DescribeGroupOther、DescribeGroups、DescribeVmGroupRevisionInfo、UpdateHealthCheckSettings

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

LicenseGrantee

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

名称	必选	允许NULL	类型	描述
Name	否	是	String	被授予者名称示例值：
UserFullName	否	是	String	客户全称示例值：

Interface

描述接口信息

被如下接口引用：DescribeInstanceRequest

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

RealtimeLogSet

实时日志查询结果集合

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

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

BillingConfig

计费配置

被如下接口引用：DescribeBillingConfig

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

TapmInstanceResp

tapm 实例的结构体

被如下接口引用：DescribeApmInstances

名称	必选	允许NULL	类型	描述
Content	是	是	Array of ApmInstanceDetail	tapm实例信息示例值：查看
TotalCount	是	是	Int64	tapm实例总数示例值：

TsfPageNamespaceServiceOverview

命名空间维度的服务概览翻页对象

被如下接口引用：DescribeNamespaceServiceOverview

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	记录总数示例值：
Content	是	是	Array of NamespaceServiceOverview	记录实体列表示例值：查看

ListScalableRuleResult

被如下接口引用：ListScalableRule

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	TotalCount 示例值：
Content	是	是	Array of ScalableRule	Content 示例值：查看

CircuitBreakerStrategy

熔断策略

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

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

ContainerInstanceResourceConfig

容器实例相关的参数配置

被如下接口引用：DescribeResourceConfig

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

Filter

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

被如下接口引用：DescribeInstances、DescribeMicroservice

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

UnitNamespace

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

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

名称	必选	允许NULL	类型	描述
NamespaceName	是	否	String	命名空间Name 示例值：
Id	否	是	String	单元化命名空间ID 示例值：
GatewayInstanceId	否	是	String	网关实体ID 示例值：
CreatedTime	否	是	String	创建时间示例值：
UpdatedTime	否	是	String	更新时间示例值：
NamespaceId	是	否	String	命名空间ID 示例值：
DestUnitId	否	是	String	关联超云单元ID 示例值：
DestUnitName	否	是	String	关联超云单元Name 示例值：
DestTsfId	否	是	String	关联超云TsfId 示例值：
DestTsfName	否	是	String	关联超云TsfName 示例值：

TsfConfigCenter

配置中心

被如下接口引用：BindNamespaceConfig、DescribeConfigCenters、DescribeConfigReleases、DescribeExclusiveConfigCenters、DescribeFileConfigReleases、DescribeGroupRelease、DescribeNamespacesConfig、DescribePublicConfigReleases、ReleaseConfigWithDetailResp

名称	必选	允许NULL	类型	描述
ConfigType	否	是	String	配置中心类型示例值：
ConfigCenterInstanceId	否	是	String	配置中心实例id 示例值：
ConfigCenterInstanceName	否	是	String	配置中心实例名称示例值：
RegionId	否	是	String	实例地域id 示例值：
NamespaceId	否	是	String	命名空间id 示例值：
CurrentVersion	否	是	String	当前版本示例值：
TargetVersion	否	是	String	需要升级的版本示例值：

VportTypeResult

被如下接口引用：ListTsfModuleVports、ListTsfModulesDetail、ModifyModuleConf

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

CosDownloadInfo

Cos下载所需信息

被如下接口引用：DescribeDownloadInfo、GetDownloadInfo

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

DtsTransaction

DTS主事务

被如下接口引用：DescribeDtsTransactions

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

PermCat

tsf-privilege 模块 PermissionCategory 权限组

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

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

CommonGroupAttribute

通用部署组额外属性

被如下接口引用：DescribeCommonGroupAttribute

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

ClsRealtimeLogSet

实时日志查询结果集合

被如下接口引用：SearchRealtimeClsLog

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

AppIdEntity

租户ID

被如下接口引用：DescribeCurrentAppId

名称	必选	允许NULL	类型	描述
AppId	是	是	String	租户ID 示例值：

TraceSpanDetail

span查询的出参

被如下接口引用：DescribeSpanDetail

名称	必选	允许NULL	类型	描述
GroupId	否	是	String	部署组id 示例值：
ServiceName	否	是	String	服务名示例值：
Name	否	是	String	调用链name 示例值：
ResultStatus	否	是	String	状态示例值：
LocalEndpoint	否	是	ZipkinEndpointV2	local端点信息示例值：查看
GroupName	否	是	String	部署组名称示例值：
ClusterType	否	是	String	集群类型示例值：
LaneName	否	是	String	泳道名称示例值：
ServiceId	否	是	String	服务Id 示例值：
ParentId	否	是	String	调用链parentid 示例值：
Kind	否	是	String	调用链类型示例值：
NamespaceId	否	是	String	命名空间id 示例值：
NamespaceName	否	是	String	命名空间名称示例值：
ResultCode	否	是	String	状态码示例值：
CustomTagList	否	是	Array of SpanLabel	用户自定义metadata列表示例值：查看
LocalComponent	否	是	String	组件示例值：
TagList	否	是	Array of SpanLabel	tags列表示例值：查看
LaneId	否	是	String	泳道id 示例值：
TraceId	否	是	String	调用链traceid 示例值：
SpanId	否	是	String	调用链spanid 示例值：
Timestamp	否	是	Uint64	时间戳示例值：
Duration	否	是	Float	耗时示例值：
RemoteEndpoint	否	是	ZipkinEndpointV2	remote端点信息示例值：查看
TsfId	否	是	String	TsfId 示例值：
TsfName	否	是	String	Tsf 名示例值：
TsfUnitId	否	是	String	单元 ID 示例值：
TsfUnitName	否	是	String	单元名示例值：
UnitType	否	是	String	单元类型示例值：
RatelimitRuleName	否	是	String	限流规则名称示例值：
RatelimitRuleId	否	是	String	限流规则Id 示例值：
IsMultiTsf	否	是	Bool	多套tsf 示例值：

NamespaceConfigResult

命名空间配置

被如下接口引用：DescribeNamespacesConfig

名称	必选	允许NULL	类型	描述
NamespaceId	否	是	String	命名空间id 示例值：
ConfigCenters	否	是	Array of TsfConfigCenter	配置中心详情示例值：查看
DualStatus	否	是	String	DUAL_STATUS_WRITE_REGISTRATION_ON 双写&&双注册开启 DUAL_STATUS_WRITE_REGISTRATION_OFF 双写&&双注册关闭示例值：

TsfPageClusterV2

Tsf分页集群对象

被如下接口引用：DescribeClusters

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

Provider

provider

被如下接口引用：CreateAndDownloadTemplate、CreateTemplate

名称	必选	允许NULL	类型	描述
ProviderControllerName	是	是	String	ProviderControllerName 示例值：

ShardArgument

分片参数

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

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

ServerlessGroup

Serverless部署组信息

被如下接口引用：DescribeServerlessGroup、DescribeServerlessGroups

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

UnitCloudArchitecture

单元化架构

被如下接口引用：CreateAndReleaseArchConfig

名称	必选	允许NULL	类型	描述
LocalCloudId	否	否	String	当前云平台id 示例值：
CloudSpaces	否	否	Array of CloudSpace	云空间示例值：查看
BusinessSystems	否	否	Array of BusinessSystem	业务系统示例值：查看
UpdatedTime	否	否	String	更新时间戳示例值：
UpdatedShowTime	否	否	String	更新时间，由UpdatedTime转换而来，用于前端展示示例值：
DataAppId	否	否	String	数据所属 appId 示例值：
DataUin	否	否	String	数据所属 uin 示例值：
DataSubAccountUin	否	否	String	数据所属 sub uin 示例值：
CloudSpace	否	否	CloudSpace	当前环境对应的云空间示例值：查看

ImageUserIsExistsResult

被如下接口引用：DescribeImageUserIsExists

名称	必选	允许NULL	类型	描述
Data	是	是	ImageUserIsExists	用户是否存在示例值：查看

HealthCheckConfig

健康检查配置

被如下接口引用：CreateApplication、DeployApplication、DeployContainerApplication、DescribeApplication、DescribeApplications、DescribeContainerGroupDeployInfo、DescribeGroups、DescribeSimpleApplications、DescribeVmGroupRevisionInfo、ModifyApplication、OperateKubeInject

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

MonitorStatisticsPolicy

MonitorStatisticsPolicy值

被如下接口引用：DescribeMonitorStatisticsPolicy、ListMonitorStatisticsPolicy

名称	必选	允许NULL	类型	描述
NamespaceId	是	是	String	命名空间id 示例值：
CreateTime	是	是	String	创建时间示例值：
UpdateTime	是	是	String	更新时间示例值：
Description	否	是	String	备注示例值：
PolicyId	是	是	String	监控统计策略id 示例值：
KeyWords	是	是	String	关键词示例值：
GroupList	是	是	Array of MonitorStatisticsPolicyGroup	部署组列表信息示例值：查看
ClusterId	否	是	String	集群ID 示例值：
GroupIds	否	是	Array of String	部署组Id列表示例值：

TsfPageGroupInstanceUnified

DescribeGroupInstancesUnified 的结果

被如下接口引用：DescribeGroupInstancesUnified

名称	必选	允许NULL	类型	描述
Content	是	是	Array of GroupInstanceUnified	列表数据示例值：查看
TotalCount	是	是	Int64	总数量示例值：

CircuitBreakerRules

分页展示路由规则

被如下接口引用：DescribeCircuitBreakerRules

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

MetricDataPoint

监控统计数据点

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

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

BusinessLogConfigAssociatedGroup

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

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

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

MultiValueDataPoints

多值数据点集合

被如下接口引用：DescribeInvocationMetricScatterPlot

名称	必选	允许NULL	类型	描述
Points	是	是	Array of MultiValue	多值数据点示例值：查看
MetricName	是	是	String	指标名称示例值：
PointKeys	是	是	Array of String	多值数据点key列表，每个值表示当前数据点所在区域的下限示例值：

ResourcePoolInstance

弹性伸缩资源池实例

被如下接口引用：DescribeResourcePoolInstances

名称	必选	允许NULL	类型	描述
LanIp	是	是	String	实例内网 IP 示例值：
WanIp	否	是	String	实例外网 IP 示例值：
InstanceStatus	是	是	String	实例机器状态示例值：
InstanceAvailableStatus	是	是	String	实例tsf可用状态示例值：
Zone	是	是	String	实例所在可用区示例值：
ResourcePoolId	是	是	String	实例资源池 ID 示例值：
InstanceId	是	是	String	实例 ID 示例值：
InstanceName	是	是	String	实例名称示例值：

ContainerGroupOther

部署组列表-其它字段

被如下接口引用：DescribeContainerGroupAttribute

名称	必选	允许NULL	类型	描述
InstanceNum	是	否	Int64	实例总数示例值：
CurrentNum	是	否	Int64	已启动实例总数示例值：
LbIp	是	否	String	负载均衡ip 示例值：
Message	是	否	String	服务状态，请参考后面的状态定义示例值：
Envs	是	是	Array of Env	环境变量示例值：查看
NodePort	是	是	Uint64	Service NodePort 示例值：
HealthCheckSettings	是	是	HealthCheckSettings	健康检查相关字段示例值：查看
IsNotEqualServiceConfig	是	是	Bool	服务配置信息是否匹配示例值：
ClusterIp	是	否	String	Service ip 示例值：
Status	是	否	String	服务状态，请参考后面的状态定义示例值：
SubnetId	是	是	String	子网ID 示例值：
AllowPlainYamlDeploy	否	是	Bool	允许原生yaml部署示例值：
TagName	否	是	String	标签名示例值：
RepoName	否	是	String	镜像名示例值：
LbDns	否	是	String	负载均衡器的DNS地址示例值：
ContainerKind	否	是	String	ContainerKind 示例值：
MaxSurge	否	是	String	MaxSurge 示例值：
KubeInjectEnable	否	是	Bool	KubeInjectEnable 示例值：
UpdatedNum	否	是	Uint64	UpdatedNum 示例值：
MaxUnavailable	否	是	String	MaxUnavailable 示例值：
ProtocolPorts	否	是	Array of ProtocolPort	ProtocolPorts 示例值：查看
UserEnvs	否	是	Array of Env	UserEnvs 示例值：查看
ConfigCenterTypeList	否	是	Array of String	ConfigCenterTypeList 示例值：
StaticIpEnabled	否	是	Bool	StaticIpEnabled 示例值：
AccessType	否	是	Uint64	AccessType 示例值：

ContainerGroupPlainYaml

部署组简单 Yaml

被如下接口引用：DescribeContainerGroupPlainYaml

名称	必选	允许NULL	类型	描述
Yaml	是	是	String	简单 Yaml 示例值：

DtsBranch

DTS分支事务

被如下接口引用：DescribeDtsBranches

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

UnitRuleResult

路由规则查询结果

被如下接口引用：DescribeUnitRouteConfig

名称	必选	允许NULL	类型	描述
TotalCount	否	否	Int64	总数量示例值：
Content	否	否	Array of UnitRuleObject	单元化规则结果列表示例值：查看

DescribeResourceConfigSts

DescribeResourceConfig

被如下接口引用：DescribeResourceConfig

名称	必选	允许NULL	类型	描述
Uin	是	是	String	uin 示例值：

SidecarFilters

分页展示过滤器

被如下接口引用：DescribeSidecarFilters

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

TsfPageRecordV2

操作记录列表对象

被如下接口引用：DescribeRecords

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

StageSpec

发布单阶段信息

被如下接口引用：ModifyReleasePipeline

名称	必选	允许NULL	类型	描述
Name	否	是	String	阶段名称示例值：
Tasks	否	是	Array of TaskSpec	任务列表示例值：查看

TsfPageRelease

发布单信息列表

被如下接口引用：DescribeReleases、DescribeSimpleReleases

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	发布单总数示例值： 10
Content	是	是	Array of Release	发布单信息列表示例值：查看

UnitArchNamespace

单元化架构命名空间

被如下接口引用：DescribeArchUnitNamespaces

名称	必选	允许NULL	类型	描述
Id	否	否	String	命名空间id 示例值：
Name	否	否	String	命名空间名称示例值：
BusinessSystemName	否	否	String	业务系统名称示例值：

TcrRepoInfo

tcr仓库信息

被如下接口引用：CreateBuildTask、DeployContainerApplication、DeployContainerGroup、DescribeBuildTasks、DescribeContainerGroupDeployInfo、DescribeImageRepository、DescribeImageTags、ImageGetRepositoryList、ImageGetTagList、OperateApplicationTcrBinding

名称	必选	允许NULL	类型	描述
RepoName	否	是	String	仓库名示例值：
Region	否	是	String	地域（填数字）示例值：
RegistryId	否	是	String	实例id 示例值：
RegistryName	否	是	String	实例名示例值：
Namespace	否	是	String	命名空间示例值：

ContainerAdditionalResourceRequirementMap

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

被如下接口引用：DescribeResourceConfig

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

PackageConfig

程序包相关配置信息

被如下接口引用：DescribeResourceConfig

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

SDUTrafficRule

SDU -> GDU 转换规则

被如下接口引用：CreateAndReleaseArchConfig

名称	必选	允许NULL	类型	描述
SDUId	否	否	String	SDU id 示例值：
CloudSpaceId	否	否	String	云空间id 示例值：
GDUId	否	否	String	GDU id 示例值：

ApiRequestDescr

被如下接口引用：DescribeApiDetail

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

DeliveryConfigBindGroups

描述配置项绑定的部署组

被如下接口引用：DescribeDeliveryConfigs

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

DtsGroupStatistics

事务分组统计信息

被如下接口引用：DescribeDtsGroupStatistics

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

ApiGroupInfo

API分组信息

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

名称	必选	允许NULL	类型	描述
CreatedTime	是	是	String	分组创建时间如:2019-06-20 15:51:28 示例值：
UpdatedTime	是	是	String	分组更新时间如:2019-06-20 15:51:28 示例值：
BindedGatewayDeployGroups	是	是	Array of GatewayDeployGroup	api分组已绑定的网关部署组示例值：查看
ApiCount	是	是	Int64	api 个数示例值：
Description	是	是	String	描述示例值：
GatewayInstanceType	是	是	String	网关实例的类型示例值：
GatewayInstanceId	是	是	String	网关实例ID 示例值：
NamespaceNameKeyPosition	是	是	String	命名空间参数位置，path，header或query，默认是path 示例值：
AuthType	是	是	String	鉴权类型。 secret：密钥鉴权； none:无鉴权示例值：
Status	是	是	String	发布状态, drafted: 未发布。 released: 发布示例值：
GroupType	是	是	String	分组类型。 ms：微服务分组； external:外部Api分组示例值：
NamespaceNameKey	是	是	String	命名空间参数key值示例值：
ServiceNameKey	是	是	String	微服务名参数key值示例值：
ClusterId	否	是	String	集群ID 示例值：
ClusterType	否	是	String	集群类型，虚拟机集群：V，容器集群：C。示例值：
GroupId	是	是	String	Api Group Id 示例值：
AclMode	是	是	String	访问group的ACL类型示例值：
ServiceNameKeyPosition	是	是	String	微服务名参数位置，path，header或query，默认是path 示例值：
ClusterName	否	是	String	集群名称示例值：
GatewayInstanceIdList	否	是	Array of String	网关实例ID列表示例值：
GroupName	是	是	String	Api Group 名称示例值：
GroupContext	是	是	String	分组上下文示例值：

NamespaceServiceOverview

命名空间维度的服务概览

被如下接口引用：DescribeNamespaceServiceOverview

名称	必选	允许NULL	类型	描述
RunMicroserviceInstanceCount	是	是	Int64	服务在线实例数目示例值：
NamespaceName	是	是	String	命名空间名示例值：
NamespaceId	是	是	String	命名空间ID 示例值：
RunMicroserviceCount	是	是	Int64	运行微服务数目（dubbo 的独立计算）示例值：

ChangeOrderDetail

被如下接口引用：DescribeChangeOrderDetail

名称	必选	允许NULL	类型	描述
TaskId	否	是	String	变更单ID（任务ID）示例值：
Status	否	是	Int64	变更状态：0：变更中 1：变更成功 2:变更失败示例值：
GroupId	否	是	String	部署组ID 示例值：
GroupName	否	是	String	部署组名称示例值：
UpdateType	否	是	Int64	发布方式：0:快速更新 1:滚动更新示例值：
UpdateIvl	否	是	Int64	滚动更新必填，更新间隔示例值：
MaxSurge	否	是	String	kubernetes滚动更新策略的MaxSurge参数示例值：
MaxUnavailable	否	是	String	kubernetes滚动更新策略的MaxUnavailable参数示例值：
StartTime	否	是	String	开始时间示例值：
ContainerKind	否	是	String	容器类型示例值：
ChangeType	否	是	Int64	变更类型示例值：
Partition	否	是	Int64	分区示例值：

Event

事件

被如下接口引用：DescribeEventDetail

名称	必选	允许NULL	类型	描述
Level	是	是	String	事件等级示例值：
Dimensions	是	是	Array of TsfEventAttribute	对象详情示例值：查看
Attributes	是	是	Array of TsfEventAttribute	事件详情示例值：查看
EventId	否	是	String	事件 Id 示例值：
AppId	是	是	String	appId值示例值：
Category	是	是	String	事件类型示例值：
Name	是	是	String	事件名，事件摘要示例值：
Object	是	是	String	事件影响对象示例值：
OccurTime	是	是	Uint64	触发时间示例值：
Status	是	是	String	事件状态示例值：
Timestamp	否	是	String	时间戳示例值：
Event	否	是	String	事件示例值：
Region	否	是	String	地域示例值：

ConsulAccessInfo

注册中心接入配置信息

被如下接口引用：DescribeResourceTsfConfig

名称	必选	允许NULL	类型	描述
Addrs	否	是	Array of String	注册中心地址列表示例值：

TsfPageConfigReleaseLog

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

被如下接口引用：DescribeConfigReleaseLogs、DescribePublicConfigReleaseLogs

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

TsfPageDimension

维度分页

被如下接口引用：DescribeInvocationMetricDataDimension

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	总数示例值：
Content	是	否	Array of String	维度示例值：

OperationInfo

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

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

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

ContainGroupResult

部署组列表（应用下钻）

被如下接口引用：DescribeContainerGroups、ListContainGroup

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

EventFilter

事件过滤器

被如下接口引用：DescribeEventCategoryName、DescribeEventDetail、DescribeEventStatistics、DescribeEventTrend、DescribeOverviewEvent

名称	必选	允许NULL	类型	描述
Key	是	否	String	过滤器 Key 示例值：
Value	是	否	Array of String	过滤器 Value 示例值：

ImportErrorRegex

导入失败的网关重定向配置

被如下接口引用：ImportPathRewrites

名称	必选	允许NULL	类型	描述
Path	是	是	String	请求路径示例值：
Reason	是	是	String	失败原因示例值：

ThreadTraceGroupData

DescribeThreadDump 接口出参封装

被如下接口引用：DescribeThreadDump

名称	必选	允许NULL	类型	描述
TraceId	是	否	String	trace ID字串示例值：
TraceString	是	否	String	trace字符串（栈信息）示例值：
Count	是	否	Int64	trace组线程数示例值：

DescribeResourceConfigLicenseFunction

DescribeResourceConfig

被如下接口引用：DescribeResourceConfig

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

ImageTag

列表信息

被如下接口引用：DescribeImageTags、ImageGetTagList

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

LaneRuleTag

泳道规则标签

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

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

InstancesResult

被如下接口引用：ListTsfModulesDetail

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

EventStatisticsResult

事件统计内容

被如下接口引用：DescribeEventStatistics

名称	必选	允许NULL	类型	描述
Item	是	是	String	影响对象名示例值：
Content	是	是	Array of TsfEventAttribute	统计结果示例值：查看
Category	是	是	String	String 示例值：

TsfPageFileConfigRelease

文件配置项发布信息列表

被如下接口引用：DescribeFileConfigReleases

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	数量示例值：
Content	是	是	Array of FileConfigRelease	列表示例值：查看

ContainerGroupObservabilityConfig

可观测配置

被如下接口引用：DeployContainerApplication、DescribeContainerGroupDeployInfo、OperateKubeInject

名称	必选	允许NULL	类型	描述
BusinessLogConfigIdList	否	是	Array of String	日志配置项ID列表示例值：无
BusinessLogDeliveryConfigIdList	否	是	Array of String	投递配置项ID列表示例值：无
AgentMemRequest	否	是	String	agent容器的 mem Request 示例值： 125
AgentCpuRequest	否	是	String	agent容器的 cpu Request 示例值： 0.1
AgentMemLimit	否	是	String	agent容器的 mem Limit 示例值： 400
AgentCpuLimit	否	是	String	agent容器的 cpu Limit 示例值： 0.2
FullImagePath	否	是	String	完整的镜像地址示例值： ccr.v120.fsphere.cn/tsf_base/agent:1.46
EnableTelemetry	否	是	Bool	是否启用可观测示例值： false

TsfPageApiDetailInfo

ApiDetailInfo 翻页对象

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

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

KubeNamespacePage

kubernetes命名空间列表

被如下接口引用：DescribeContainerNamespaces、DescribeExtraKubeNamespaces

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	记录条数示例值：
Content	是	否	Array of KubeNamespace	记录内容示例值：查看

Service

tsf-privilege模块，产品

被如下接口引用：DescribeServices

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

BillingAuthSign

计费下单签名

被如下接口引用：DescribeBillingAuthSign

名称	必选	允许NULL	类型	描述
Goods	是	否	String	商品信息示例值：
Auth	是	否	GenerateSignAuth	签名详情示例值：查看
AppId	是	否	String	租户ID 示例值：
Uin	是	否	String	主账号ID 示例值：
OwnerUin	否	否	String	主账号ID 示例值：
Platform	否	否	String	平台示例值：

EventDataCurveResult

事件趋势线

被如下接口引用：DescribeEventTrend

名称	必选	允许NULL	类型	描述
Category	是	否	String	事件类型示例值：
EventDataPoints	是	否	Array of EventDataPointResult	事件趋势曲线点集示例值：查看

CommonPkg

公共包信息

被如下接口引用：DescribeCommonPkg

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

MultiValue

多值数据

被如下接口引用：DescribeInvocationMetricScatterPlot

名称	必选	允许NULL	类型	描述
Values	否	是	Array of Float	数据点示例值：

OverviewHostResourceUsage

TSF实例相关基本信息概览

被如下接口引用：DescribeHostResourceUsage

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

Namespace

命名空间

被如下接口引用：DescribeNamespaces、DescribeSimpleNamespaces

名称	必选	允许NULL	类型	描述
NamespaceId	是	是	String	命名空间ID 示例值：
NamespaceDesc	是	是	String	命名空间描述示例值：
CreateTime	是	是	String	创建时间示例值：
ClusterId	是	是	String	集群ID 示例值：
ProgramId	否	是	String	ProgramId 示例值：
NamespaceCode	是	是	String	命名空间编码示例值：
NamespaceType	是	是	String	命名空间类型示例值：
NamespaceStatus	是	是	String	命名空间状态示例值：
UpdateTime	是	是	String	更新时间示例值：
ClusterList	是	是	Array of Cluster	集群数组，仅携带集群ID，集群名称，集群类型等基础信息。示例值：查看
IsHaEnable	是	是	String	是否开启高可用示例值：
KubeInjectEnable	是	是	Bool	KubeInjectEnable值示例值：
ProgramIdList	否	是	Array of String	ProgramIdList 示例值：
NamespaceName	是	是	String	命名空间名称示例值：
IsDefault	是	是	String	默认命名空间示例值：
DeleteFlag	是	是	Bool	删除标识示例值：
NamespaceResourceType	是	是	String	集群资源类型示例值：
RegistryType	否	是	String	无示例值：
CreateK8sNamespaceFlag	否	是	Bool	无示例值：
DoubleRegistry	否	是	Bool	无示例值：
CreateSource	否	是	String	无示例值：
NamespaceNameList	否	是	Array of String	无示例值：
Language	否	是	String	无示例值：
EnableTsfRegistry	否	是	Bool	无示例值：
RegistryAddress	否	是	String	无示例值：
EnableSelfRegistry	否	是	Bool	无示例值：

RuleConfig

规则配置

被如下接口引用：CreateAndReleaseUnitRouteConfig

名称	必选	允许NULL	类型	描述
RuleConfigName	否	否	String	规则项名称示例值：
Conditions	否	否	Array of Condition	标签匹配示例值：查看
ConditionOperator	否	否	String	标签逻辑关系，支持 AND/OR 示例值：
TargetUnitId	否	否	String	目标单元id 示例值：
TargetUnitName	否	否	String	目标单元名称示例值：
CloudSpaceName	否	否	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元数据列表示例值：查看
InterfaceName	否	是	String	Span接口名（前端展示）示例值：
LocalEndpoint	否	是	ZipkinEndpointV2	Span本地端点示例值：查看
RemoteEndpoint	否	是	ZipkinEndpointV2	Span远程端点示例值：查看
LabelList	否	是	Array of SpanLabel	Span标签列表示例值：查看
IsMultiTsf	否	是	Bool	跨集群状态示例值：
UnitType	否	是	String	单元化状态示例值：
NamespaceId	否	是	String	命名空间ID 示例值：
GroupId	否	是	String	部署组ID 示例值：
NamespaceName	否	是	String	命名空间名字示例值：

DescribeLoadBalancersFilter

查询负载均衡列表过滤条件

被如下接口引用：DescribeLoadBalancers

名称	必选	允许NULL	类型	描述
Key	否	否	String	过滤Key 示例值：
Value	否	否	String	过滤Value 示例值：

MethodProfile

方法执行分析

被如下接口引用：DescribeJvmMonitorMethodProfile

名称	必选	允许NULL	类型	描述
MethodProfileData	是	是	String	方法执行分析数据示例值：
Status	是	是	String	调用成功success/调用失败error 示例值：
StatusInfo	是	是	String	调用成功为""/调用失败为对应失败信息示例值：
StatusCode	是	是	Int64	调用成功为0/调用失败为对应的错误码示例值：

PathRewriteDto

网关重定向配置

被如下接口引用：ImportPathRewrites

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

TsfLoadBalancerDetail

TSF负载均衡器详情

被如下接口引用：DescribeLoadBalancers

名称	必选	允许NULL	类型	描述
LoadBalancerType	否	是	String	负载均衡类型示例值：
Domain	否	是	String	负载均衡域名示例值：
Status	否	是	Uint64	负载均衡状态示例值：
LoadBalancerVips	否	是	Array of String	负载均衡vips 示例值：
LoadBalancerId	否	否	String	负载均衡ID 示例值：
LoadBalancerName	否	是	String	负载均衡名称示例值：

FunctionStatusResult

功能状态返回结果

被如下接口引用：DescribeFunctionStatus

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

GatewayGroupApiVo

网关API简单信息

被如下接口引用：DescribeGatewayAllGroupApis、ImportGroupApis

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

ResourceBatchOperationDescription

资源批次操作描述

被如下接口引用：DescribeResourceBatchOperation

名称	必选	允许NULL	类型	描述
EnableForcedStop	是	否	Bool	是否强制终止变更示例值：
BatchNum	是	否	Uint64	批次个数示例值：
BatchExeMode	是	否	String	批次执行方式示例值：
GroupId	是	否	String	部署组ID 示例值：
GroupName	是	否	String	部署组名称示例值：
CreateTime	是	否	String	创建时间示例值：
DeployWaitTime	否	是	Int64	分批等待时间，单位min，默认值 0 示例值：
DeployStrategy	否	是	Int64	部署方式，0为快速发布，1为滚动发布示例值：
EnableBeta	是	否	Bool	是否存在beta批次示例值：
TaskType	是	否	Uint64	批次任务类型示例值：
EnableBatchHealthCheck	否	是	Bool	批次健康检查是否开启示例值：

TsfPageInstance

TSF机器实例分页对象

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

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

MicroserviceExtra

微服务（信息更丰富版）

被如下接口引用：DescribeMicroservicesByAssociateApplication

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

TagRouteItemList

标签路由规则

被如下接口引用：CreateRouteRule、DescribeRouteReleaseHistory

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

ThreadDetailInfo

线程数据详情

被如下接口引用：DescribeThreadDetailList

名称	必选	允许NULL	类型	描述
ThreadName	是	否	String	线程名示例值：
ThreadState	是	否	String	线程状态示例值：
ThreadInfos	是	否	String	线程堆栈信息示例值：
ThreadCpuUtil	是	是	Float	CPU利用率示例值：
ThreadAllocatedBytes	是	是	Int64	堆内存大小示例值：
ThreadCpuTime	是	是	Int64	CPU 运行时间示例值：
ThreadBlockCount	是	是	Int64	线程阻塞个数示例值：
Compression	否	是	Bool	如果为"true"代表相关数据是压缩后的示例值：

TsfPageBuildTask

构建任务列表对象

被如下接口引用：DescribeBuildTasks

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Uint64	总个数示例值： 0
Content	是	否	Array of BuildTaskInfo	构建任务列表示例值：查看

BusinessLogConfigSchemaV2

业务日志配置解析规则

被如下接口引用：AnalyzeLogScema

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

GatewayPluginDefinition

微服务网关插件定义数据

被如下接口引用：DescribeGatewayPluginTypes

名称	必选	允许NULL	类型	描述
Order	是	是	Int64	插件排序示例值：
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 示例值：

LicenseResource

被如下接口引用：DescribeLicenseApplications

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

ThreadStateData

DescribeThreadDump 接口出参封装

被如下接口引用：DescribeThreadDump

名称	必选	允许NULL	类型	描述
NewCount	是	否	Int64	新创建线程数示例值：
RunnableCount	是	否	Int64	运行中线程数示例值：
BlockedCount	是	否	Int64	阻塞线程数示例值：
WaitingCount	是	否	Int64	等待线程数示例值：
TimedWaitingCount	是	否	Int64	计时等待线程数示例值：
TerminatedCount	是	否	Int64	终止线程数示例值：
TotalCount	是	否	Int64	线程总数示例值：

TsfPageConfigCenter

配置中心分页列表

被如下接口引用：DescribeConfigCenters、DescribeExclusiveConfigCenters

名称	必选	允许NULL	类型	描述
TotalCount	否	是	Int64	总条数示例值：
Content	否	是	Array of TsfConfigCenter	配置中心实例列表示例值：查看

BillingOperationRecord

计费操作记录

被如下接口引用：DescribeBillingOperationRecords

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

TaskRecordPage

翻页查询的任务记录返回

被如下接口引用：DescribeTaskRecords

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

PathRewrite

路径重写

被如下接口引用：DescribePathRewrite、DescribePathRewrites

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

RatelimitRuleForUpdate

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

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

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

ServerlessGroupPage

ServerlessGroup 翻页对象

被如下接口引用：DescribeServerlessGroups

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

UserProgramValuesObject

UserProgramValues

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

名称	必选	允许NULL	类型	描述
UserProgramValues	否	是	Array of UserProgramValue	Program 示例值：查看

GatewayWeChatMiniProgramLoginPlugin

微服务网关微信登录插件

被如下接口引用：DescribeGatewayWeChatMiniProgramLoginPlugin

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

ResourceTaskStatusResult

资源任务转态结果

被如下接口引用：DescribeResourceTaskStatus

名称	必选	允许NULL	类型	描述
RunCount	是	否	Uint64	无示例值：
FailCount	是	否	Uint64	无示例值：
TimeoutCount	否	是	Uint64	无示例值：
TaskStatus	是	是	Uint64	任务的执行状态示例值：
TotalCount	是	否	Uint64	无示例值：
SuccessCount	是	否	Uint64	无示例值：

GatewayDeployGroup

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

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

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

SimpleApplication

简单应用

被如下接口引用：DescribeSimpleApplications

名称	必选	允许NULL	类型	描述
ApplicationId	是	是	String	应用ID 示例值： application-6a79x94v
ApplicationName	是	是	String	应用名称示例值： java-app
ApplicationDesc	是	是	String	ApplicationDesc 示例值： this is a desc
ProgLang	是	是	String	ProgLang 示例值： J
ApplicationResourceType	是	是	String	ApplicationResourceType 示例值： C
ApmInstanceName	否	是	String	Apm业务系统Name 示例值： app-apm
UpdateTime	是	是	String	UpdateTime 示例值： 2020-12-13 11:23:45
ApigatewayServiceId	是	是	String	ApigatewayServiceId 示例值： gw-ins-6a79x94v
ApplicationRuntimeType	是	是	String	ApplicationRuntimeType 示例值： konaJdk8
ServiceConfigList	是	是	Array of ServiceConfig	ServiceConfigList 示例值：查看
ApplicationType	是	是	String	应用类型示例值： C
CreateTime	是	是	String	CreateTime 示例值： 2020-12-13 11:23:45
ApplicationRemarkName	否	是	String	ApplicationRemarkName 示例值： app-remark
AmpInstanceId	否	是	String	Apm业务系统id 示例值： apm-6a79x94v
MicroserviceType	是	是	String	应用微服务类型示例值： N
IgnoreCreateImageRepository	否	是	Bool	忽略创建镜像仓库示例值： false
ApmInstanceId	否	是	String	Apm业务系统id 示例值： apm-6a79x94v
ApplicationNameList	否	是	Array of String	应用名称列表示例值： ["application-6a79x94v"]
MicroserviceSubType	否	是	String	应用微服务子类型示例值： SCG
ProgramLanguage	否	是	String	应用编程语言类型示例值： J
ServiceGovernanceConfig	否	是	ContainerGroupServiceGovernanceConfig	应用服务治理信息示例值：查看
SyncDeleteImageRepository	否	是	Bool	是否同步删除镜像仓库示例值： false
FrameworkType	否	是	String	应用开发框架类型示例值： SpringCloud
MicroserviceTypeList	否	是	Array of String	微服务类型列表示例值： []

AuthRule

微服务权限规则

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

名称	必选	允许NULL	类型	描述
Tags	是	否	Array of AuthConditionV2	标签列表示例值：查看
Type	是	否	String	规则类型示例值：
RuleId	是	否	String	规则ID 示例值：
RuleName	是	否	String	规则名称示例值：
IsEnabled	是	否	String	是否启用示例值：
CreateTime	是	否	String	创建时间示例值：
UpdateTime	是	否	String	更新时间示例值：
MicroserviceId	是	否	String	微服务ID 示例值：
TypeCheck	否	是	String	是否校验鉴权，新版本都要校验，false 时为兼容老场景的示例值：

FilebeatConfig

filebeat对象

被如下接口引用：DescribeFilebeatConfig、DescribeFilebeatConfigPage

名称	必选	允许NULL	类型	描述
ConfigDesc	是	是	String	配置描述示例值：
ConfigYaml	是	是	String	配置内容示例值：
ConfigType	是	是	String	配置类型 common - 通用配置 business - 日志配置项 delivery - 日志投递项示例值：
ConfigCreateTime	是	是	String	配置创建时间示例值：
ConfigUpdateTime	是	是	String	配置最近一次更新时间示例值：
ConfigId	是	是	String	配置id 示例值：
ConfigName	是	是	String	配置名称示例值：

ZipkinEndpointV2

调用链Span端点信息

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

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

RatelimitDimension

限流规则作用的标签维度

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

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

ConfigTemplate

配置模板对象

被如下接口引用：CreateConfigTemplateWithDetailResp、DescribeConfigTemplate、DescribeConfigTemplates

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

ImageUserIsExists

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

被如下接口引用：DescribeImageUserIsExists

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

LaneInfos

泳道分页查询

被如下接口引用：DescribeLanes

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

TsfPageZone

TSF可用区列表对象

被如下接口引用：DescribeTsfZones

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

PathRewriteCreateObject

路径重写创建对象

被如下接口引用：CreatePathRewrites、CreatePathRewritesWithDetailResp

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

ConfigMapOption

ConfigMap可选项

被如下接口引用：DeployContainerApplication、DeployContainerGroup、DescribeContainerGroupDeployInfo

名称	必选	允许NULL	类型	描述
Key	否	否	String	- 示例值：
Path	否	否	String	- 示例值：
Mode	否	否	String	- 示例值：

InvocationIndicator

服务调用监控指标

被如下接口引用：DescribeInovcationIndicators

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

ContainerAdditionalResourceRequirement

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

被如下接口引用：DescribeResourceConfig

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

Affinity

亲和规则

被如下接口引用：DeployContainerApplication、DeployContainerGroup、DescribeContainerGroupDeployInfo

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

ConfigDownloadParam

配置下载参数

被如下接口引用：DownloadConfig

名称	必选	允许NULL	类型	描述
ConfigName	否	是	String	配置名称示例值：
ApplicationId	否	是	String	应用id 示例值：

InstanceRequest

单条实例请求详情

被如下接口引用：DescribeInstanceRequest

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

GroupRelease

部署组配置发布相关信息

被如下接口引用：DescribeGroupRelease

名称	必选	允许NULL	类型	描述
TagName	是	是	String	镜像版本示例值：
PublicConfigReleaseList	是	是	Array of ConfigRelease	已发布的全局配置列表示例值：查看
ConfigReleaseList	是	是	Array of ConfigRelease	已发布的应用配置列表示例值：查看
FileConfigReleaseList	是	是	Array of FileConfigRelease	已发布的文件配置列表示例值：查看
PackageId	是	是	String	程序包ID 示例值：
PackageName	是	是	String	程序包名示例值：
PackageVersion	是	是	String	程序包版本示例值：
RepoName	是	是	String	镜像名示例值：

SidecarFilterGroup

过滤器关联的部署组

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

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

DescribeSingleContainerGroupsResult

被如下接口引用：DescribeSingleContainerGroups

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	列表数量示例值： 10
Content	是	是	Array of DescribeSingleContainerGroups	列表内容示例值：查看

GatewayOAuthPlugin

被如下接口引用：DescribeGatewayOAuthPlugin

名称	必选	允许NULL	类型	描述
CreatedTime	是	是	String	插件创建时间如:2019-06-20 15:51:28 示例值： 2026-01-01 00:00:00
Name	是	是	String	插件名称示例值： plugin-sin2
TokenAuthUrl	是	是	String	验证token路径示例值： https://cloud.com
TokenKeyName	是	是	String	token的key值示例值： plugin-sn
PayloadMappingName	是	是	String	payload的映射参数名称示例值： {"sv_tsf_publiccloud_platinum0115_presaleplatinum":500,"pid":1002167,"timeUnit":"d"}
PayloadMappingPosition	是	是	String	payload映射到后端服务的携带位置,值:query/header 示例值： {"sv_tsf_publiccloud_platinum0115_presaleplatinum":500,"pid":1002167,"timeUnit":"d"}
Id	是	否	String	网关插件id 示例值： id-pllugiin-s
UpdatedTime	是	是	String	插件更新时间如:2019-06-20 15:51:28 示例值： 2026-01-01 00:00:00
TokenAuthMethod	是	是	String	验证token请求方法:get/post 示例值： PUT
ExpireTime	是	是	Int64	认证请求超时时间,单位:秒范围:0~30 示例值： 2026-12-31 00:00:00
RedirectUrl	是	是	String	重定向地址示例值： https://cloud.com
TokenBaggagePosition	是	是	String	token携带位置，网关取token位置与发送认证请求时token位置一致,值:query/header 示例值： HEADER
Description	是	是	String	插件描述示例值： plugin desc
Type	是	是	String	插件类型示例值： OAuth
Status	是	是	String	发布状态: drafted/released 示例值： drafted
TokenAuthServiceName	否	是	String	token微服务名示例值： ns-sjg2js/provider-demo

TsfPageSearchLog

业务日志列表

被如下接口引用：SearchClsLog、SearchRealtimeClsLog

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

EnvsV2

环境变量

被如下接口引用：AnalyzeLogScema、AnalyzeLogSchema、DescribeContainerGroupDeployInfo、ValidateLogSchema

名称	必选	允许NULL	类型	描述
Name	是	否	String	环境变量名称示例值：
Value	是	是	String	服务端口示例值：
ValueFrom	否	是	ValueFrom	k8s ValueFrom 示例值：查看

DeliveryConfigBindGroup

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

被如下接口引用：DescribeAssociateRelation、DescribeDeliveryConfigs

名称	必选	允许NULL	类型	描述
CreateTime	是	是	String	创建时间示例值：
KafkaVIp	否	是	String	KafkaVIp 示例值：
Username	否	是	String	Username 示例值：
KafkaVPort	否	是	String	KafkaVPort 示例值：
EnableAuth	否	是	Bool	EnableAuth 示例值：
Password	否	是	String	Password 示例值：
ConfigId	是	否	String	配置id 示例值：
CollectPath	是	是	Array of String	采集路径示例值：
LineRule	否	是	String	LineRule 示例值：
EnableGlobalLineRule	否	是	Bool	EnableGlobalLineRule 示例值：
ConfigName	是	否	String	配置名示例值：
KafkaAddress	否	是	String	KafkaAddress 示例值：
Topic	否	是	String	Topic 示例值：
CustomRule	否	是	String	CustomRule 示例值：
KafkaInfos	否	是	Array of DeliveryKafkaInfo	KafkaInfos 示例值：查看
Groups	是	是	Array of GroupInfo	关联部署组信息示例值：查看

ApplicationConfig

应用配置信息

被如下接口引用：DescribeReleaseTemplate、ModifyReleaseTemplate

名称	必选	允许NULL	类型	描述
ConfigName	否	是	String	配置名称示例值：
ConfigVersion	否	是	String	配置版本示例值：
ConfigId	否	是	String	配置ID 示例值：

LaneRule

泳道规则

被如下接口引用：DescribeLaneRule、DescribeLaneRules

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

OperationInfoDetail

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

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

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

GatewayGroupIds

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

被如下接口引用：BindApiGroup、UnbindApiGroup

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

ThreadDumpData

DescribeThreadDetail 接口出参封装

被如下接口引用：DescribeThreadDump

名称	必选	允许NULL	类型	描述
MethodDistDataList	是	否	Array of MethodDistData	线程当前所在函数分布信息列表示例值：查看
ThreadStateData	是	否	Array of ThreadStateData	线程状态信息示例值：查看
ThreadGroupDataList	是	否	Array of ThreadGroupData	线程组信息(同名线程) 示例值：查看
TotalThreadGroupCount	是	否	Int64	线程组总数示例值：
NativeThreadCountData	是	否	Array of NativeThreadCountData	本机线程计数数据示例值：查看
TotalTraceGroupCount	是	否	Int64	线程trace信息组数示例值：
ThreadTraceGroupDataList	是	否	Array of ThreadTraceGroupData	线程trace信息组列表示例值：查看
TotalMethodDistCount	是	否	Int64	函数分布总数示例值：

TsfPageRouteReleaseHistory

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

被如下接口引用：DescribeRouteReleaseHistory

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

ImageFeature

镜像特征

被如下接口引用：DescribeImageFeatures

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

SidecarStatus

sidecar 状态

被如下接口引用：DescribeMeshSidecarStatus

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

Config

配置项

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

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

ServiceStatisticsResults

服务统计结果集

被如下接口引用：DescribeStatistics

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

GCLogData

DescribeGCLog接口返回GC日志数据封装

被如下接口引用：DescribeGCLog

名称	必选	允许NULL	类型	描述
Status	是	是	String	调用成功success/调用失败error 示例值：
StatusInfo	是	是	String	调用成功为""/调用失败为对应失败信息示例值：
StatusCode	是	是	Int64	调用成功为0/调用失败为对应的错误码示例值：
Data	是	是	String	分析的GC日志结果示例值：

EventDetail

事件详情

被如下接口引用：DescribeEventDetail

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	总数示例值：
Content	是	否	Array of Event	事件详情示例值：查看

TsfPageRegion

TSF地域列表对象

被如下接口引用：DescribeTsfRegions

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

TsfPageGatewayPluginModel

被如下接口引用：DescribeGatewayWithPlugin

名称	必选	允许NULL	类型	描述
TotalCount	否	是	Int64	条数示例值：
Content	否	是	Array of GatewayPluginModel	网关实例示例值：查看

GroupsByScalableRuleIdList

被如下接口引用：ListGroupsByScalableRuleId

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	TotalCount 示例值：
Content	是	是	Array of GroupsByScalableRuleId	Content 示例值：查看

VmInstanceResourceConfig

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

被如下接口引用：DescribeResourceConfig

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

FileConfigRelease

文件配置项发布信息

被如下接口引用：DescribeFileConfigReleases、DescribeGroupRelease

名称	必选	允许NULL	类型	描述
ClusterId	否	是	String	集群ID 示例值：
ClusterName	否	是	String	集群名称示例值：
ApplicationId	否	是	String	ApplicationId 示例值：
ConfigCenters	否	是	Array of TsfConfigCenter	配置中心发布详情示例值：查看
ConfigId	否	是	String	配置项ID 示例值：
ConfigName	否	是	String	配置项名称示例值：
ConfigVersion	否	是	String	配置项版本示例值：
ReleaseDesc	否	是	String	发布描述示例值：
ReleaseTime	否	是	String	发布时间示例值：
GroupId	否	是	String	部署组ID 示例值：
NamespaceId	否	是	String	命名空间ID 示例值：
NamespaceName	否	是	String	命名空间名称示例值：
ConfigReleaseId	否	是	String	配置项发布ID 示例值：
GroupName	否	是	String	部署组名称示例值：

TsfPageTraceInterface

调用链接口列表

被如下接口引用：GetOssTraceInterfaces

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

BusinessLogPatternAnalysis

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

被如下接口引用：AnalyzeLogScema、AnalyzeLogSchema、ValidateLogSchema

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

GroupRevision

部署组版本信息

被如下接口引用：DescribeGroupRevision、DescribeGroupRevisions

名称	必选	允许NULL	类型	描述
RevisionType	是	否	String	版本的产生方式【CONTAINER_DEPLOY、CONTAINER_YAML、VM_DEPLOY】示例值：
GroupId	是	否	String	部署组id 示例值：
CreateTime	是	否	String	创建时间示例值：
LastDeployTime	是	否	String	最后发布时间示例值：
IsCurrentRevision	是	否	Bool	是否为正在使用版本示例值：
CanRollback	是	否	Bool	是否可用于回滚示例值：
RevisionId	是	否	String	主键id 示例值：
RevisionDesc	是	是	String	版本描述示例值：
Artifacts	是	否	String	制品示例值：
Snapshot	否	是	String	版本快照数据示例值：

Result

FindMonitorObject返回的结果

被如下接口引用：FindMonitorObject、FindServiceMonitorObject

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

ZipkinSpanInfoV2

调用链Span信息

被如下接口引用：GetOssTraceSpans

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

ResourceOperationStatusResult

描述操作执行结果

被如下接口引用：InterruptResourceBatchOperation

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

MetricStatistic

网关监控统计信息

被如下接口引用：DescribeGatewayMonitorDetails

名称	必选	允许NULL	类型	描述
HttpClientErrors	否	是	Float	客户端平均错误数。示例值： 88.00
HttpServerErrors	否	是	Float	服务端平均错误数。示例值： 100.00
Period	否	是	Float	平均数对应的时间粒度示例值： 60
Requests	否	是	Float	平均请求数。示例值： 66.00
Latency	否	是	Float	平均请求耗时。示例值： 55.00
Errors	否	是	Float	平均错误数。示例值： 50.00
ErrorRate	否	是	Float	平均错误率。示例值： 100.00

ProductNews

产品动态

被如下接口引用：DescribeProductNews、ReleaseProductNews

名称	必选	允许NULL	类型	描述
NewsId	否	是	String	id 示例值：
Link	否	是	String	链接示例值：
Order	否	是	Int64	排序示例值：
Title	否	是	String	标题示例值：
ServiceTag	否	是	String	产品标识(默认为tsf) 示例值：
Page	否	是	String	页面位置。多个可以逗号隔开aa,bb 示例值：
Content	否	是	String	内容示例值：
StyleFlag	否	是	String	样式Flag 示例值：
Valid	否	是	Int64	是否有效示例值：
ValidTime	否	是	String	生效时间（当valid从0 -> 1，刷新生效时间）示例值：

InterfaceRequests

多条接口请求详情

被如下接口引用：DescribeInterfaceRequest

名称	必选	允许NULL	类型	描述
Content	是	是	Array of InterfaceRequest	interfaceRequest数组示例值：查看
TotalCount	是	是	Int64	总条数示例值：

GatewayNamespace

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

被如下接口引用：DescribeAuthNamespaces

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

JvmMonitorData

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

被如下接口引用：DescribeJvmMonitor

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

VmTask

虚拟机操作记录

被如下接口引用：DscribeTasks

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

Extension

扩展信息

被如下接口引用：CreateAndReleaseArchConfig

名称	必选	允许NULL	类型	描述
Service	否	否	String	组件名称，如tsf 示例值：
Data	否	否	String	扩展数据示例值：

FileConfigReleaseLog

文件配置项发布日志

被如下接口引用：DescribeFileConfigReleaseLogs

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

AuthConditionV2

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

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

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

NativeThreadCountData

DescribeThreadDump 接口出参封装

被如下接口引用：DescribeThreadDump

名称	必选	允许NULL	类型	描述
JavaThreadCount	是	否	Int64	java线程数示例值：
NonJavaCount	是	否	Int64	非java线程数示例值：

BillingDeal

计费订单

被如下接口引用：DescribeBillingDealRecords

名称	必选	允许NULL	类型	描述
DealName	是	是	String	订单号示例值： 20250908110011
ResourceId	是	是	String	资源ID 示例值： tsf-dapolkvo
CategoryId	是	是	Int64	种类ID 示例值： 101473
CreateTime	是	是	String	创建时间示例值： 2025-09-08 17:59:11
AppId	是	是	String	租户ID 示例值： 1255000100
CommonPolicy	是	是	Int64	官网折扣示例值： 0
DealDetail	是	是	String	订单详情示例值： {"sv_tsf_publiccloud_platinum0115_presaleplatinum":500,"pid":1002167,"timeUnit":"d"}
Uin	是	是	String	账号ID 示例值： 110000000128
SubAccountUin	是	是	String	子账号ID 示例值： 110000000128
Currency	是	是	String	币种示例值： USD
TotalCost	是	是	Int64	原价（单位分）示例值： 100
RealTotalCost	是	是	Int64	折后价（单位分）示例值： 90
TotalPolicy	是	是	Int64	总折扣示例值： 0
UserPolicy	是	是	Int64	用户折扣示例值： 0
Nickname	否	是	String	昵称示例值： brucep

MetricDataPointMap

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

被如下接口引用：DescribeUnitApiUseDetail

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

GatewayJwtPlugin

微服务网关JWT插件

被如下接口引用：DescribeGatewayJwtPlugin

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

ImportErrorGroupApi

网关批量导入API失败结果

被如下接口引用：ImportGroupApis

名称	必选	允许NULL	类型	描述
Reason	否	是	String	失败原因示例值：
Method	否	是	String	方法示例值：
MicroserviceName	否	是	String	服务名称示例值：
NamespaceName	否	是	String	命名空间名称示例值：
Path	否	是	String	path 示例值：

Gateway

网关

被如下接口引用：CreateAndReleaseArchConfig、ReleaseUnitGateways

名称	必选	允许NULL	类型	描述
GatewayId	否	否	String	网关id 示例值：
Vip	否	否	String	网关VIP 示例值：
Port	否	否	String	网关端口示例值：
BusinessSystemId	否	否	String	业务系统id 示例值：
CloudSpaceId	否	否	String	云空间 id 示例值：
CloudId	否	否	String	云平台 id 示例值：
RegionId	否	否	String	地域 id 示例值：

TsfPageGatewayInstance

网关实体分页信息

被如下接口引用：DescribeGatewayInstances、DescribeGatewayInstancesByApplication、DescribeGatewayInstancesByMultiCloud

名称	必选	允许NULL	类型	描述
Content	是	是	Array of GatewayInstance	翻页数据示例值：查看
TotalCount	是	是	Int64	数据总数示例值：

TsfPageTraceService

调用链服务名列表

被如下接口引用：GetOssTraceServices、GetTraceServices

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

ApiDetailResponse

ApiDetailResponse描述

被如下接口引用：DescribeApiDetail

名称	必选	允许NULL	类型	描述
Description	是	是	String	API 描述示例值：
MsgwApiType	否	是	String	MsgwApiType 示例值：
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 示例值：

ReleaseTask

发布单任务信息

被如下接口引用：DescribeReleasePipeline、DescribeReleasePipelineRun、DescribeReleasePipelineTask

名称	必选	允许NULL	类型	描述
TaskSpec	是	否	TaskSpec	任务基本信息示例值：查看
TaskStatus	是	否	String	任务状态示例值：
StartTime	否	是	Int64	任务开始时间示例值：
EndTime	否	是	Int64	任务结束时间示例值：

TsfPageRouteV2

路由分页列表

被如下接口引用：DescribeRoutes

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

ApmInstanceBrief

apm业务系统实例数据的简述

被如下接口引用：DescribeUnassociatedInstances

名称	必选	允许NULL	类型	描述
InstanceId	否	是	String	业务系统Id 示例值：
InstanceName	否	是	String	业务系统Name 示例值：

PagedProductNews

产品动态分组分页对象

被如下接口引用：DescribeProductNews

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

CosUploadInfo

cos上传所需信息

被如下接口引用：DescribeUploadInfo、GetUploadInfo

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

FileConfig

文件配置项

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

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

SidecarFilter

lua过滤器

被如下接口引用：DescribeSidecarFilter、DescribeSidecarFilters

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

BusinessLogConfig

业务日志配置

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

名称	必选	允许NULL	类型	描述
ConfigTags	否	是	String	配置项标签示例值：
ConfigAssociatedGroups	否	是	Array of BusinesLogConfigAssociatedGroup	配置项关联部署组示例值：查看
ConfigAssociatedGroupList	否	是	Array of BusinessLogConfigAssociatedGroup	配置项关联部署组示例值：查看
FilebeatHarvesterLimit	否	是	Int64	filebeat harvester_limit参数示例值：
ConfigId	否	否	String	配置项ID 示例值：
ConfigName	否	否	String	配置项名称示例值：
ConfigPipeline	否	是	String	配置项对应的ES管道示例值：
ConfigSchema	否	是	BusinessLogConfigSchema	配置项解析规则示例值：查看
ProgramIdList	否	是	Array of String	无示例值：
FilebeatCloseTimeout	否	是	Int64	close_timeout参数示例值：
FilebeatIgnoreOlder	否	是	Int64	filebeat ignore_older参数示例值：
FilebeatCloseInactive	否	是	Int64	filebeat close_inactive参数示例值：
ConfigPath	否	是	String	配置项日志路径示例值：
ConfigDesc	否	是	String	配置项描述示例值：
ConfigCreateTime	否	是	String	配置项创建时间示例值：
ProgramId	否	是	String	无示例值：
FilebeatCleanInactive	否	是	Int64	filebeat clean_inactive参数示例值：
ConfigUpdateTime	否	是	String	配置项更新时间示例值：
FilebeatConfigEnable	否	是	Bool	是否开启filebeat高级配置开关示例值：

CloudApiV3Error

yunapi错误码返回值

被如下接口引用：CreateClsLogset、DescribeClsLogsets、DescribeClsTopics

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

ContainerGroupResourceConfig

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

被如下接口引用：DescribeResourceConfig

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

ScalableRuleAttribute

ScalableRuleAttribute值

被如下接口引用：DescribeScalableRuleAttribute

名称	必选	允许NULL	类型	描述
ShrinkVmCount	是	是	Int64	ShrinkVmCount值示例值： 2
EnableCronAS	是	是	Uint64	开启定时伸缩规则, 默认0, 0:关闭定时伸缩 1:开启定时伸缩示例值： 0
Name	是	是	String	Name值示例值： tsf-as-xx
EnableShrink	是	是	Int64	EnableShrink值示例值： 0
ExpandVmCount	是	是	Int64	ExpandVmCount值示例值： 3
CoolTime	是	是	Int64	CoolTime值示例值： 300
ExpandSubruleList	是	是	Array of ExpandSubrule	ExpandSubruleList值示例值：查看
CreateTime	是	是	String	CreateTime值示例值： 20260515
UpdateTime	是	是	String	UpdateTime值示例值： 20260515
Desc	否	是	String	备注示例值： description
EnableExpand	是	是	Int64	EnableExpand值示例值： 0
ExpandVmCountLimit	是	是	Int64	ExpandVmCountLimit值示例值： 3
ShrinkSubruleList	是	是	Array of ExpandSubrule	ShrinkSubruleList值示例值：查看
Description	否	是	String	备注示例值： description
DisableMetricAS	是	是	Uint64	是否关闭指标伸缩, 默认0, 0:打开指标伸缩 1:关闭指标伸缩示例值： 0
CronRuleList	是	是	Array of CronRule	定时伸缩规则列表示例值：查看
ShrinkPeriod	是	是	Int64	ShrinkPeriod值示例值： 300
ShrinkVmCountLimit	是	是	Int64	ShrinkVmCountLimit值示例值： 2
RuleId	是	是	String	RuleId值示例值： tsf-as-rule-xx
ExpandPeriod	是	是	Int64	ExpandPeriod值示例值： 20
ExpandSubRuleList	否	否	Array of ExpandSubrule	ExpandSubRuleList 示例值：查看
ShrinkSubRuleList	否	否	Array of ExpandSubrule	ShrinkSubRuleList 示例值：查看

ReleaseStage

发布单阶段信息

被如下接口引用：DescribeReleasePipeline、DescribeReleasePipelineRun

名称	必选	允许NULL	类型	描述
Name	否	是	String	阶段名示例值：
Tasks	否	是	Array of ReleaseTask	任务节点信息示例值：查看

VmGroupRevisionInfo

虚拟机部署组历史版本详情信息

被如下接口引用：DescribeVmGroupRevisionInfo

名称	必选	允许NULL	类型	描述
GroupName	否	是	String	部署组名示例值：
Alias	否	是	String	别名示例值：
PackageId	否	是	String	程序包id 示例值：
StartScript	否	是	String	启动脚本示例值：
HealthCheckSettings	否	是	HealthCheckSettings	健康检查设置示例值：查看
EnableBatchHealthCheck	否	是	Bool	是否开启健康检查示例值：
AgentProfileList	否	是	Array of AgentProfile	部署agent的类型、版本示例值：查看
GroupId	否	是	String	部署组id 示例值：
ApplicationId	否	是	String	应用id 示例值：
DeployWaitTime	否	是	Int64	分批等待时间示例值：
GovernanceType	否	是	String	共享/独占示例值：
ForceStart	否	是	Bool	强制开启示例值：
BusinessLogConfigIdList	否	是	Array of String	日志配置id列表示例值：
JdkVersion	否	是	String	jdk版本示例值：
GovernanceAccessType	否	是	String	服务治理接入类型示例值：
EnableTelemetryAgent	否	是	Bool	启停Tapm Agent 示例值：
ClusterName	否	是	String	集群名示例值：
ApplicationName	否	是	String	应用名示例值：
ExclusiveInstances	否	是	Array of ExclusiveInstance	注册服务治理实例示例值：查看
ServiceConfigList	否	是	Array of ServiceConfig	服务配置列表示例值：查看
TapmOtAgentVersion	否	是	String	tapm agent版本示例值：
NamespaceName	否	是	String	命名空间名示例值：
RepositoryType	否	是	String	仓库类型示例值：
DeployBetaEnable	否	是	Bool	是否开启beta部署示例值：
DeployExeMode	否	是	String	批次执行方式示例值：
ServiceAgentVersion	否	是	String	service agent版本示例值：
NamespaceId	否	是	String	命名空间id 示例值：
JdkName	否	是	String	jdk名称示例值：
StopScript	否	是	String	停止脚本示例值：
DeployDesc	否	是	String	部署组描述示例值：
OtAgentVersion	否	是	String	agent版本示例值：
RepositoryId	否	是	String	仓库ID 示例值：
RepositoryName	否	是	String	仓库名称示例值：
Tags	否	是	Array of Tag	标签列表示例值：查看
DeployBatch	否	是	Array of Float	部署批次示例值：
EnableGovernance	否	是	Bool	开启服务治理示例值：
BusinessLogDeliveryConfigIdList	否	是	Array of String	日志deliverId列表示例值：
UpdateType	否	是	Int64	更新策略示例值：
ClusterId	否	是	String	集群id 示例值：
VmInstanceRevisionInfos	否	是	Array of VmInstanceRevisionInfo	实例信息示例值：查看
StartupParameters	否	是	String	启动参数示例值：
EnableHealthCheck	否	是	Bool	是否开启健康检查示例值：
WarmupSetting	否	是	WarmupSetting	预热设置示例值：查看
ServiceSpecEncode	否	是	String	serviceSpecEncode 示例值：
GatewayConfig	否	是	GatewayConfig	网关配置示例值：查看

ESUserInfo

es用户信息

被如下接口引用：GetApmEsAuthInfo

名称	必选	允许NULL	类型	描述
EnableTaw	是	是	Bool	是否使用taw 示例值：
TawToken	是	是	String	taw token 示例值：
EsAuthInfo	否	是	ESAuthInfo	用户鉴权信息示例值：查看

CtsdbInfo

CTSDB配置信息

被如下接口引用：DescribeResourceTsfConfig

名称	必选	允许NULL	类型	描述
Username	否	是	String	用户名示例值：
Password	否	是	String	密码示例值：
Addrs	否	是	Array of String	ctsdb地址列表示例值：

SimpleGroup

部署组

被如下接口引用：DescribeSimpleGroups

名称	必选	允许NULL	类型	描述
KubeInjectEnable	否	是	Bool	KubeInjectEnable 示例值：
ApplicationType	是	是	String	应用类型示例值：
NamespaceName	是	是	String	命名空间名称示例值：
StartupParameters	是	是	String	启动参数示例值：
JdkName	否	是	String	JdkName 示例值：
JdkVersion	否	是	String	JdkVersion 示例值：
ServiceAgentVersion	否	是	String	ServiceAgentVersion 示例值：
GroupName	是	是	String	部署组名称示例值：
ApplicationName	是	是	String	应用名称示例值：
NamespaceId	是	是	String	命名空间ID 示例值：
Status	否	是	String	Status 示例值：
UpdateType	否	是	Int64	UpdateType 示例值：
StopScript	否	是	String	StopScript 示例值：
Alias	否	是	String	Alias 示例值：
K8sNamespaceName	否	是	String	k8s 命名空间名称示例值：
GroupId	是	是	String	部署组ID 示例值：
ClusterId	是	是	String	集群ID 示例值：
GroupResourceType	是	是	String	部署组资源类型示例值：
StartScript	否	是	String	StartScript 示例值：
ServiceSpecEncode	否	是	String	ServiceSpecEncode 示例值：
OtAgentVersion	否	是	String	OtAgentVersion 示例值：
ApplicationId	是	是	String	应用ID 示例值：
ClusterName	是	是	String	集群名称示例值：
ClusterType	是	是	String	集群类型示例值：
AppMicroServiceType	是	是	String	应用微服务类型示例值：
GatewayConfig	否	是	String	GatewayConfig 示例值：
WarmupSetting	否	是	String	WarmupSetting 示例值：
UnitType	否	是	String	单元类型示例值：
UnitEnvType	否	是	String	单元环境类型示例值：
EnabledUnit	否	是	Bool	是否单元化示例值：
EnableBatchHealthCheck	否	是	Bool	是否开启分批健康检查示例值：
UnitName	否	是	String	单元名示例值：
BusinessSystemName	否	是	String	无示例值：
UnitId	否	是	String	单元id 示例值：
FilebeatMaxCpu	否	是	String	FilebeatMaxCpu 示例值：
GovernanceType	否	是	String	GovernanceType 示例值：
BusinessLogDeliveryConfigIdList	否	是	Array of String	BusinessLogDeliveryConfigIdList 示例值：
NonInvasiveType	否	是	String	NonInvasiveType 示例值：
DeployBatch	否	是	String	DeployBatch 示例值：
HealthCheckSettings	否	是	String	HealthCheckSettings 示例值：
BusinessSystemId	否	是	String	BusinessSystemId 示例值：
InstanceIdList	否	是	Array of String	InstanceIdList 示例值：
ExclusiveInstances	否	是	String	ExclusiveInstances 示例值：
EnableTelemetry	否	是	String	EnableTelemetry 示例值：
EnableTelemetryAgent	否	是	String	EnableTelemetryAgent 示例值：
Tags	否	是	String	Tags 示例值：
EnableGovernance	否	是	String	EnableGovernance 示例值：
DeployWaitTime	否	是	String	DeployWaitTime 示例值：
ClsMachineGroupId	否	是	String	ClsMachineGroupId 示例值：
BusinessLogConfigIdList	否	是	String	BusinessLogConfigIdList 示例值：
FilebeatCgroupEnable	否	是	Bool	FilebeatCgroupEnable 示例值：
DeployBetaEnable	否	是	String	DeployBetaEnable 示例值：
EnableHealthCheck	否	是	Bool	EnableHealthCheck 示例值：
FilebeatMaxMem	否	是	String	FilebeatMaxMem 示例值：
DeployExeMode	否	是	String	DeployExeMode 示例值：
MicroserviceSubType	否	是	String	MicroserviceSubType 示例值：
RealNamespaceName	否	是	String	RealNamespaceName 示例值：
FrameworkType	否	是	String	FrameworkType 示例值：
TapmOtAgentVersion	否	是	String	TapmOtAgentVersion 示例值：

DtsRetryError

DTS重试事务异常信息

被如下接口引用：RetryTransactions

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

MetricDataCurve

指标监控数据曲线

被如下接口引用：DescribeGatewayMonitorDetails、DescribeInstanceMonitorDetails、DescribeInvocationMetricDataCurve、DescribeStatistics

名称	必选	允许NULL	类型	描述
MetricName	是	是	String	指标名称示例值：
MetricFunction	是	是	String	指标计算方式示例值：
MetricDataPoints	是	是	Array of MetricDataPoint	指标数据点集合示例值：查看
PolarisInstanceId	否	是	String	北极星实例id 示例值：

ZipkinMetadata

调用链Span元数据

被如下接口引用：GetTraceSpans

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

KubeNamespace

kubernetes命名空间

被如下接口引用：DescribeContainerNamespaces、DescribeExtraKubeNamespaces

名称	必选	允许NULL	类型	描述
K8sNamespace	否	否	String	k8s命名空间示例值：
ClusterInfo	否	否	String	集群信息示例值：
Name	否	否	String	k8s命名空间名称示例值：
ClusterId	否	否	String	集群ID 示例值：

OperateKubeInjectResult

OperateKubeInjectResult值

被如下接口引用：OperateKubeInject

名称	必选	允许NULL	类型	描述
Success	是	是	Bool	Success值示例值：

LicenseApplicationRecord

LicenseApplicationRecord值

被如下接口引用：DescribeLicenseApplications

名称	必选	允许NULL	类型	描述
CreateTime	是	否	Uint64	创建时间示例值：
IssueTime	否	是	Uint64	授予许可时间示例值：
Duration	否	是	LicenseDuration	有效期信息示例值：查看
UsageScenario	否	是	String	使用场景示例值：
ApplyReason	否	是	String	申请原因示例值：
Grantee	是	否	LicenseGrantee	授予对象示例值：查看
Product	否	否	Array of LicenseProduct	所申请的产品信息列表示例值：查看
Phone	否	是	Array of String	联系电话示例值：
Email	否	是	Array of String	联系邮箱示例值：
Description	否	是	String	备注示例值：
ProductInfo	否	是	String	产品信息示例值：
Status	否	是	Int64	未作废0；已作废1 示例值：

ListAlarmReceiverResult

被如下接口引用：ListAlarmReceivers

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	TotalCount 示例值：
Content	是	是	Array of AlarmReceiverResult	Content 示例值：查看

TsfPageVmGroup

列表中部署组分页信息

被如下接口引用：DescribeGroups

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

DescribeResourceConfigResultV2

DescribeResourceConfig

被如下接口引用：DescribeResourceConfig

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

RouteRuleV2

路由规则项

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

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

TypeCode

术语描述对象，码表

被如下接口引用：DescribeRecordCodes

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

ManagerJobInfoPage

运营端任务管理列表页

被如下接口引用：ListManagerJobInfo

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	无示例值：
Content	是	是	Array of ManagerJobInfo	无示例值：查看

ModuleParameterResult

被如下接口引用：SaveDeployModuleParams

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

ServiceSetting

容器网络设置。

被如下接口引用：CreateContainerService、DeployContainerApplication、DeployContainerGroup、DescribeContainerGroupDeployInfo、ModifyContainerService

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

TsfPageBillingLicense

BillingLicense 翻页对象

被如下接口引用：DescribeAllBillingLicenses

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

UnitRouteRuleTag

单元化规则标签

被如下接口引用：DescribeUnitRouteConfig

名称	必选	允许NULL	类型	描述
TagField	否	否	String	标签名示例值：
TagOperator	否	否	String	匹配条件，支持IN/NOT_IN/EQUAL/NOT_EQUAL/REGEX/RANGE 示例值：
TagValue	否	否	String	值示例值：

BuildTaskInfo

构建任务信息

被如下接口引用：DescribeBuildTasks

名称	必选	允许NULL	类型	描述
Status	是	否	String	- STOP 未启动 - BUILDING 构建中 - BUILD_SUCCESS 构建成功 - BUILD_FAILED 构建失败 - CANCEL 用户取消示例值： BUILDING
PackageName	是	否	String	构建包的名称示例值： consumer-demo-1.29.4-Finchley-RELEASE.jar
ErrorMessage	是	是	String	构建失败的原因示例值： error
StartTime	是	否	Uint64	开始时间，unix 时间戳，精确到毫秒。示例值： 1770206396986
EndTime	是	否	Uint64	结束时间，unix 时间戳，精确到毫秒。示例值： 0
Tag	是	否	String	镜像版本示例值： 1.0
BuildTaskId	是	否	String	构建任务id 示例值： build-task-jnyg3a23
JdkVersion	否	是	String	jdk版本示例值： KANO
ApplicationId	否	是	String	应用ID 示例值： application-l9yn5dyd
RepoType	否	是	String	仓库类型示例值： Personal
BuildTaskIds	否	是	Array of String	构建任务列表示例值： ["task-12"]
PkgId	否	是	String	包ID 示例值： pkg-12
PackageType	否	是	String	包类型示例值： JAR
WarEnvironment	否	是	String	war包环境示例值： TOMCAT9
TcrRepoInfo	否	是	TcrRepoInfo	tcr仓库信息示例值：查看

ApiUseStatisticsEntity

API 日统计数据点

被如下接口引用：DescribeApiUseDetail

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

ClsSearchLog

业务日志

被如下接口引用：SearchClsLog、SearchRealtimeClsLog

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

TsfEventAttribute

事件属性

被如下接口引用：DescribeEventCategoryName、DescribeEventDetail、DescribeEventDimension、DescribeEventStatistics、DescribeOverviewEvent

名称	必选	允许NULL	类型	描述
Key	是	否	String	属性 key 示例值：
Value	是	否	String	属性 Value 示例值：

RouteElementMappingService

路由要素转换服务

被如下接口引用：CreateAndReleaseUnitRouteConfig

名称	必选	允许NULL	类型	描述
CloudId	否	否	String	云平台 id 示例值：
CloudSpaceName	否	否	String	云空间名称示例值：
RouteElementMappingService	否	否	String	路由转换服务示例值：

MsInstance

微服务实例信息

被如下接口引用：DescribeMicroservice

名称	必选	允许NULL	类型	描述
InstanceId	是	是	String	机器实例ID信息示例值： ins-anrptnkf
InstanceName	是	是	String	机器实例名称信息示例值： ins_cvm
LanIp	是	是	String	机器实例内网IP 示例值： 192.168.0.1
InstanceAvailableStatus	是	是	String	机器可用状态示例值： Running
ApplicationType	是	是	String	应用类型示例值： C
RegistrationId	是	是	String	实例注册id 示例值： ins-apigateway-service-online-845f765877-2gz57
HiddenStatus	是	是	String	屏蔽状态，hidden 为屏蔽，unhidden 为未屏蔽示例值： unhidden
ClusterId	是	是	String	集群ID 示例值： cluster-mjy9mvgz
GroupId	是	是	String	部署组ID 示例值： group-xoydmy26
ApplicationPackageVersion	是	是	String	应用程序包版本示例值： v1
ServiceStatus	是	是	String	服务状态，passing 在线，critical 离线示例值： passing
RegistrationTime	是	是	Int64	注册时间示例值： 1732784732000
AppMicroServiceType	否	是	String	微服务类型示例值： N
ApplicationId	是	是	String	应用ID 示例值： application-l6ymbvgd
ApplicationName	是	是	String	应用名称示例值： provider_app
NamespaceName	是	是	String	命名空间名称示例值： ns_app
GroupName	是	是	String	部署组名称示例值： group_app
InstanceStatus	是	是	String	机器TSF可用状态示例值： ready
MetaJson	否	是	String	json格式的 meta 信息示例值： H4sI+7Q0WqDuNxDRYwWqm064de/fZGsZg58SbI4zQp4tB6tIMBSG38XrpZgYU92d1FRkrYboBtTWTS3FR921oJuIev/0L9bD3d1wuoh5vKezCteO42Eb2cQIEU
Port	是	是	String	服务运行的端口号示例值： 8080
WanIp	是	是	String	机器实例外网IP 示例值： 192.168.0.1
ServiceInstanceStatus	是	是	String	服务运行状态示例值： Running
ClusterName	是	是	String	集群名称示例值： cls_app
NamespaceId	是	是	String	命名空间ID 示例值： namespace-96a79v5b
HealthCheckUrl	是	是	String	健康检查URL 示例值： /heath
ClusterType	是	是	String	集群类型示例值： C
LastHeartbeatTime	是	是	Int64	上次心跳时间示例值： 1732784732000
LanIpv6	否	是	String	ipv6 示例值： 2001:0db8:86a3:08d3:1319:8a2e:0370:7344

StatisticsCoord

指标坐标

被如下接口引用：GetInvocationStatistics

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

ValueFrom

k8s env 的 ValueFrom

被如下接口引用：AnalyzeLogScema、AnalyzeLogSchema、DeployContainerApplication、DeployContainerGroup、DescribeContainerGroupAttribute、DescribeContainerGroupDeployInfo、DescribeContainerGroupDetail、FindContainerGroup、ValidateLogSchema

名称	必选	允许NULL	类型	描述
SecretKeyRef	否	是	CommonRef	k8s env 的 secretKeyRef 示例值：查看
FieldRef	否	是	FieldRef	k8s env 的 FieldRef 示例值：查看
ResourceFieldRef	否	是	ResourceFieldRef	k8s env 的 ResourceFieldRef 示例值：查看
ConfigMapKeyRef	否	是	CommonRef	k8s env的configMapKeyRef 示例值：查看

CommonRef

ValueFrom 通用结构

名称	必选	允许NULL	类型	描述
Name	否	否	String	名称示例值：
Key	否	否	String	Key值示例值：

ApiDetailInfo

API 明细

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

名称	必选	允许NULL	类型	描述
Method	是	是	String	请求方法示例值：
GroupId	是	是	String	所属分组ID 示例值：
RpcType	否	是	String	RPC 类型示例值：
Region	否	是	String	Region 示例值：
Description	是	是	String	Api描述信息示例值：
RpcExt	否	是	String	RPC 额外信息示例值：
AppId	否	是	String	APP ID 示例值：
Uin	否	是	String	Uin 示例值：
ApiId	是	是	String	API ID 示例值：
MicroserviceId	是	是	String	服务ID 示例值：
PathMapping	是	是	String	Api 映射路径示例值：
UpdatedTime	是	是	String	更新时间示例值：
GatewayDeployGroupId	是	是	String	部署组id 示例值：
MicroserviceName	是	是	String	服务名称示例值：
Path	是	是	String	API 请求路径示例值：
RateLimitStatus	是	是	String	开启限流示例值：
ReleasedTime	是	是	String	发布时间示例值：
Kv	否	是	UserProgramValuesObject	Kv 示例值：查看
Action	否	是	String	Action 示例值：
UsableStatus	是	是	String	是否禁用示例值：
CreatedTime	是	是	String	创建时间示例值：
GroupName	是	是	String	所属分组名称示例值：
ApiType	是	是	String	API类型。 ms ：微服务API； external :外部服务Api 示例值：
SubAccountUin	否	是	String	SubAccountUin 示例值：
Timeout	是	是	Int64	API 超时，单位毫秒示例值：
Md5	否	是	String	md5 示例值：
Host	是	是	String	Api所在服务host 示例值：
NamespaceName	是	是	String	命名空间名称示例值：
ReleaseStatus	是	是	String	发布状态示例值：
MockStatus	是	是	String	是否开启mock 示例值：
ApiMatchType	否	是	String	API路径匹配类型。normal：普通API；wildcard：通配API。示例值：
CamContext	否	是	String	CamContext 示例值：
NamespaceId	是	是	String	命名空间ID 示例值：
BusinessSystemId	否	是	String	业务系统ID 示例值：
BusinessSystemName	否	是	String	业务系统名称示例值：

ManagerJobLog

运营端任务日志

被如下接口引用：ListManagerJobLog

名称	必选	允许NULL	类型	描述
HandleMsg	是	是	String	无示例值：
LogStatus	是	是	Int64	无示例值：
JobDesc	是	是	String	无示例值：
Id	是	是	Int64	无示例值：
JobId	是	是	Int64	无示例值：
HandleTime	是	是	Int64	无示例值：

AppPkgList

应用的包列表

被如下接口引用：ListAppPkg

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

ThreadGroupData

DescribeThreadDump 接口出参封装

被如下接口引用：DescribeThreadDump

名称	必选	允许NULL	类型	描述
GroupName	是	否	String	线程组名称示例值：
Count	是	否	Int64	线程个数示例值：

TsfPageUnitNamespace

单元化命名空间翻页对象

被如下接口引用：DescribeUnitNamespaces、DescribeUsableUnitNamespaces

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

ZipkinTraceInfoV2

调用链信息

被如下接口引用：SearchOssTrace、SearchTrace

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

GrayUnitRuleItem

规则项列表

被如下接口引用：ReleaseGrayUnitRouteRule

名称	必选	允许NULL	类型	描述
Enable	否	否	Bool	条件生效总开关示例值：
MatchMode	否	否	String	匹配模式 EQUALS（匹配灰度标识），GRAY_ID_LIST（匹配灰度名单）示例值：
GrayTrafficValue	否	否	String	匹配的值示例值：

TopicInfo

主题实体

被如下接口引用：DescribeClsTopics

名称	必选	允许NULL	类型	描述
LogsetId	否	是	String	日志集id 示例值：
TopicId	否	是	String	日志主题id 示例值：
TopicName	否	是	String	日志主题名称示例值：
Tags	否	是	Array of ApmTag	日志主题的标签示例值：查看

GatewayPlugin

微服务网关插件实例对象

被如下接口引用：DescribeGatewayPlugins、DescribePluginInstances

名称	必选	允许NULL	类型	描述
Description	是	是	String	插件描述示例值： tag 类型插件创建
Status	是	是	String	发布状态示例值： released
DeleteDisabledReason	否	否	String	禁用原因示例值：已存在绑定资源,请解绑分组或API后重试
Id	是	是	String	网关插件id 示例值： pgn-cdw2c1on
Name	是	是	String	插件名称示例值： eason-test-tag
Type	是	是	String	插件类型示例值： Tag
CreatedTime	是	是	String	创建时间示例值： 2026-03-03 11:41:31
UpdatedTime	是	是	String	更新时间示例值： 2026-03-03 17:41:31
DeleteDisabled	否	否	Bool	是否禁用删除示例值： true
BindDisabled	否	是	Bool	是否不可绑定（true 表示不可绑定）示例值： true

TsfPageCommonPkg

公共包列表

被如下接口引用：DescribeCommonPkg

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

ApplicationApiAccess

Serverless应用外网权限信息

被如下接口引用：DescribeApiAccess

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

GroupPodResult

部署组实例列表

被如下接口引用：DescribePodInstances

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总记录数示例值： 10
Content	是	是	Array of GroupPod	列表信息示例值：查看
SpecTotalCount	否	是	Int64	原始批次个数示例值： 2

MasterApiResult

透传masterApi的response回前端

被如下接口引用：DescribeAgentInfo

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

TsfPageMeshLog

mesh 日志列表

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

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

ExclusiveInstance

独占实例

名称	必选	允许NULL	类型	描述
CenterType	否	否	String	配置中心类型[注册中心Registration、配置中心Configuration] 示例值：
InstanceId	否	否	String	实例id，通过北极星控制台获取示例值：
InstanceType	否	否	String	实例类型，例如北极星Polaris 示例值：
InstanceName	否	否	String	实例名称示例值：
RegionId	否	否	String	实例地域id，通过北极星控制台获取示例值：
InstanceNamespaceId	否	否	String	实例命名空间ID，通过北极星控制台获取示例值：

ProductHelp

产品帮助

被如下接口引用：DescribeProductHelp、ReleaseProductHelp

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

ClsLogConfigId

cls 日志配置项信息

被如下接口引用：CreateClsConfig

名称	必选	允许NULL	类型	描述
ConfigId	否	是	String	日志配置项主键示例值：

BlueGreenTemplate

蓝绿发布模板

被如下接口引用：DescribeReleaseTemplate、ModifyReleaseTemplate

名称	必选	允许NULL	类型	描述
ApplicationType	是	否	String	应用类型示例值：
GreenGroups	是	否	Array of ReleaseGroup	绿组，当前只支持一个部署组示例值：查看
RepoName	否	是	String	镜像仓库名示例值：
EnableApplicationConfig	否	是	Bool	是否允许应用配置示例值：
PriorApplicationConfig	否	是	Bool	是否先进行应用配置发布，再部署程序示例值：
EnableFileConfig	否	是	Bool	是否允许文件配置示例值：
RepoType	否	是	String	镜像仓库类型示例值：
ApplicationName	是	是	String	应用名示例值：
ApplicationConfigs	否	是	Array of ApplicationConfig	应用配置列表示例值：查看
FileConfigs	否	是	Array of FileConfig	文件配置列表示例值：查看
RepositoryType	否	是	String	仓库类型示例值：
ApplicationId	是	否	String	应用ID 示例值：
MicroserviceId	是	否	String	微服务ID 示例值：
PackageVersion	否	是	String	程序包版本示例值：
RepositoryId	否	是	String	仓库id 示例值：
BlueGroups	是	否	Array of ReleaseGroup	蓝组，当前只支持一个部署组示例值：查看
PackageId	否	是	String	程序包ID 示例值：
TagName	否	是	String	镜像版本示例值：
PackageName	否	是	String	程序包名示例值：
RepositoryName	否	是	String	仓库名称示例值：

CheckTsfUnitResult

tsf单元化配置详情

被如下接口引用：CheckTsfUnitSupported

名称	必选	允许NULL	类型	描述
UnitEnabled	否	否	Bool	是否开启单元化示例值：

CircuitBreakerRule

熔断规则

被如下接口引用：DescribeCircuitBreakerRule、DescribeCircuitBreakerRules

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

PurchaseInfo

购买信息

被如下接口引用：DescribeUserPurchaseInfo

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

CloudMonitorMicroservice

被如下接口引用：DescribeMicroServiceList、ListCloudMicroServiceFindPagedList

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

EventStatistics

事件统计结果

被如下接口引用：DescribeEventStatistics

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	总数示例值：
Content	是	否	Array of EventStatisticsResult	事件统计内容示例值：查看

IpPortV2

IP地址和端口号

被如下接口引用：UpdateApplicationAgent

名称	必选	允许NULL	类型	描述
RsyncIp	否	否	String	RsyncIp地址示例值：
RsyncPort	否	否	Int64	RsyncPort端口号示例值：

TsfPageBusinessLogV2

业务日志列表

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

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总条数示例值：
Content	是	是	Array of BusinessLogV2	业务日志列表示例值：查看
ScrollId	是	是	String	游标ID 示例值：
Status	是	是	String	查询状态示例值：
SearchAfter	否	是	Array of String	查询es时，使用searchAfter返回的游标示例值：

MetricDimension

指标维度

被如下接口引用：DescribeInvocationMetricDataCurve、DescribeInvocationMetricScatterPlot

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

UnitRuleItem

微服务网关单元化规则项

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

名称	必选	允许NULL	类型	描述
DestNamespaceId	是	否	String	目的地命名空间ID 示例值：
DestNamespaceName	是	否	String	目的地命名空间名称示例值：
Id	否	是	String	规则项ID 示例值：
ItemIndex	否	是	Int64	规则项索引示例值：
CreatedTime	否	是	String	创建时间示例值：
UpdatedTime	否	是	String	修改时间示例值：
Relationship	是	否	String	逻辑关系：AND/OR 示例值：
Name	是	否	String	规则项名称示例值：
UnitRuleId	否	是	String	单元化规则ID 示例值：
Priority	否	是	Int64	规则顺序，越小优先级越高：默认为0 示例值：
Description	否	是	String	规则描述示例值：
UnitRuleTagList	否	是	Array of UnitRuleTag	规则标签列表示例值：查看
DestTsfId	否	是	String	DestTsfId 示例值：
DestUnitId	否	是	String	DestUnitId 示例值：
DestUnitName	否	是	String	DestUnitName 示例值：
DestTsfName	否	是	String	DestTsfName 示例值：
DestConfigId	否	是	String	DestConfigId 示例值：
DestConfigName	否	是	String	DestConfigName 示例值：

TsfPageTraceSpanInfo

分页spaninfo的结构

被如下接口引用：SearchSpan

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Uint64	总数示例值：
Content	是	是	Array of TraceSpanInfo	span列表示例值：查看

ApplicationForPage

分页的应用描述信息字段

被如下接口引用：DescribeApplication、DescribeApplications

名称	必选	允许NULL	类型	描述
ApplicationId	是	是	String	应用ID 示例值：
ApplicationName	是	是	String	应用名称示例值：
ApplicationType	是	是	String	应用类型示例值：
IgnoreCreateImageRepository	否	是	Bool	IgnoreCreateImageRepository 示例值：
SyncDeleteImageRepository	否	是	Bool	同步删除镜像仓库示例值：
CreateSameNameImageRepository	否	否	Bool	是否同时创建镜像仓库示例值：
ProgLang	是	是	String	编程语言示例值：
CreateTime	是	是	String	创建时间示例值：
UpdateTime	是	是	String	更新时间示例值：
ApmInstanceId	否	是	String	Apm业务系统id 示例值：
ApmInstanceName	否	是	String	Apm业务系统Name 示例值：
ApplicationDesc	是	是	String	应用描述示例值：
ApplicationResourceType	是	是	String	应用资源类型示例值：
ApplicationRuntimeType	是	是	String	应用runtime类型示例值：
MicroserviceSubType	否	是	String	应用微服务子类型示例值：
MicroserviceType	是	是	String	微服务类型示例值：
ApigatewayServiceId	是	是	String	Apigateway的serviceId 示例值：
ApplicationRemarkName	是	是	String	应用备注名示例值：
ServiceConfigList	是	是	Array of ServiceConfig	服务配置信息列表示例值：查看
ProgramLanguage	否	是	String	应用编程语言类型示例值：
FrameworkType	否	是	String	开发框架类型[SpringCloud，Dubbo，Go-GRPC，Other] 示例值：
ServiceGovernanceConfig	否	是	ServiceGovernanceConfig	注册配置治理信息示例值：查看
MicroserviceTypeList	否	是	Array of String	微服务类型列表示例值：
ApplicationNameList	否	是	Array of String	应用名列表示例值：

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 示例值：查看

GroupsByScalableRuleId

被如下接口引用：DescribeScalableRuleAttributeByGroup、ListGroupsByScalableRuleId

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

RouterIdentifier

路由要素配置

被如下接口引用：CreateAndReleaseUnitRouteConfig

名称	必选	允许NULL	类型	描述
RouteElementSplit	否	否	String	路由元素分隔符 - 如"=" , "-" 示例值：
RouteElementInSplit	否	否	String	路由元素内 kv 分隔符- "," 示例值：
RouteShardingElement	否	否	String	路由分片要素示例值：
RouteElementMappingServices	否	否	Array of RouteElementMappingService	路由要素转换服务示例值：查看

AbnormalMetricsConfig

服务监控异常指标配置

被如下接口引用：DescribeAbnormalMetricsConfig

名称	必选	允许NULL	类型	描述
ApdexSlowThreshold	否	否	Int64	apdex慢调用阈值，保留两位小数示例值：
ApdexErrorThreshold	否	否	Float	apdex错误调用阈值示例值：
IsGlobal	是	否	Bool	生效范围是否全局示例值：
ApdexSlowThresholdRange	否	否	Array of Int64	apdex慢调用阈值区间范围示例值：
AvgTimeError	是	否	Float	平均响应时间变红阈值示例值：
NamespaceId	否	是	String	命名空间id 示例值：
AvgTimeSlow	否	否	Float	平均响应时间示例值：
ErrorRate	否	否	Float	服务异常时错误率，已经乘以100，保留两位小数示例值：
ConfigId	否	是	String	配置ID 示例值：
NamespaceIdList	否	是	Array of String	命名空间列表示例值：
AppId	否	是	String	租户ID 示例值：

CloudMonitorMicroserviceResult

被如下接口引用：DescribeMicroServiceList、ListCloudMicroServiceFindPagedList

名称	必选	允许NULL	类型	描述
TotalCount	否	否	Int64	TotalCount 示例值：
Content	否	否	Array of CloudMonitorMicroservice	Content 示例值：查看

FailoverUnit

容灾单元

被如下接口引用：SwitchFailoverStatus

名称	必选	允许NULL	类型	描述
CloudId	否	否	String	云空间id 示例值：
UnitId	否	否	String	单元 id 示例值：
LocalDisasterRecoveryUnitId	否	否	String	同城灾备单元 id 示例值：
RemoteDisasterRecoveryUnitId	否	否	String	异地灾备单元 id 示例值：
CurrentDisasterRecoveryUnitId	否	否	String	当前容灾单元 Id 示例值：
Status	否	否	String	容灾状态NOMORL—正常(恢复)LOCAL_DISASTER_RECOVERY—同城容灾REMOTE_DISASTER_RECOVERY—异地容灾示例值：
ExcludeZones	否	否	Array of String	排除的可用区Id信息示例值：
RegionId	否	否	String	地域 id 示例值：
CloudSpaceId	否	否	String	云空间 id 示例值：

StatisticsEntry

概览页统计列表条目

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

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

TaskLastExecuteStatus

任务最近一次执行状态

被如下接口引用：DescribeTaskLastStatus

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

TsfPageApplicatoinServerLog

废弃

被如下接口引用：DescribeApplicatoinServerLog

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

ContainerTaskDetail

容器变更记录详情

被如下接口引用：DescribeContainerTaskDetail

名称	必选	允许NULL	类型	描述
Yaml	否	是	String	当前变更任务的快照 yaml 示例值：
CurrentYaml	否	是	String	变更任务所属部署组的最新 yaml，用于与快照版本对比示例值：

Consumer

被如下接口引用：CreateAndDownloadTemplate、CreateTemplate

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

InstanceRequests

多条实例请求详情

被如下接口引用：DescribeInstanceRequest

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	内容示例值：
Content	是	是	Array of InstanceRequest	总条数示例值：查看

TsfLogset

创建logset返回的对象信息

被如下接口引用：CreateClsLogset

名称	必选	允许NULL	类型	描述
LogsetId	否	是	String	日志集的id 示例值：
Error	否	是	CloudApiV3Error	返回错误信息示例值：查看

ApmTag

维度（标签）对象

被如下接口引用：DescribeClsLogsets、DescribeClsTopics

名称	必选	允许NULL	类型	描述
Key	是	否	String	维度Key(列名，标签Key) 示例值：
Value	是	否	String	维度值（标签值）示例值：

ServiceStatisticsResult

服务统计结果

被如下接口引用：DescribeStatistics

名称	必选	允许NULL	类型	描述
InstanceTotalCount	是	是	Int64	实例总数示例值：
NamespaceId	否	是	String	无示例值：
InstanceOnlineCountMin	否	否	Int64	在线实例数最小值示例值：
Path	是	是	String	请求模板路径:type为接口时返回，服务时不返回示例值：
MicroserviceId	是	是	String	微服务Id 示例值：
Status	是	是	String	normal/error 示例值：
ErrorRateLevel	是	是	String	normal/warn/error 示例值：
InstanceId	是	是	String	实例id 示例值：
MicroserviceName	是	是	String	微服务名称示例值：
GroupExist	是	是	Int64	部署组是否存在示例值：
NamespaceName	否	是	String	无示例值：
InstanceName	是	是	String	实例name 示例值：
InstanceExist	是	是	Int64	实例是否存在，仅限cvm 示例值：
Qps	是	是	Float	Qps值示例值：
InstanceOnlineCountMax	否	否	Int64	在线实例数最大值示例值：
Method	是	是	String	请求方法:type为接口时返回，服务时不返回示例值：
MetricDataCurves	是	是	Array of MetricDataCurve	响应耗时曲线示例值：查看
Script	是	是	String	Script值示例值：
InstanceOnlineCount	是	是	Int64	实例在线数示例值：
MicroserviceExist	否	是	Int64	无示例值：
ErrorRate	是	是	Float	请求错误率，不带百分号示例值：
AvgTimeConsuming	是	是	Float	平均响应耗时ms 示例值：
MicroserviceType	是	是	String	微服务类型示例值：
HeapUsed	是	是	Int64	已用堆大小,单位KB 示例值：
DbType	是	是	String	数据库类型示例值：
ApdexLevel	是	是	String	normal/warn/error 示例值：
GroupName	是	是	String	部署组name 示例值：
ClusterType	是	是	String	部署组类型示例值：
ApplicationId	是	是	String	应用id 示例值：
CpuPercent	是	是	Int64	cpu使用率示例值：
DbName	是	是	String	数据库示例值：
AvgTimeConsumingLevel	是	是	String	normal/warn/error 示例值：
NamespaceExist	否	是	Int64	无示例值：
RequestCount	是	是	Uint64	请求数示例值：
GroupId	是	是	String	部署组id 示例值：
Apdex	是	是	Float	Apdex值示例值：
IngressTraffic	否	是	Int64	入口流量示例值：
ClientError	否	是	Int64	客户端错误数示例值：
ConnectCount	否	是	Int64	连接数示例值：
ServerError	否	是	Int64	服务端错误数示例值：
EgressTraffic	否	是	Int64	出口流量示例值：
TsfId	否	是	Int64	tsf 平台Id 示例值：

TsfPageConfigRelease

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

被如下接口引用：DescribeConfigReleases、DescribePublicConfigReleases

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

PagedDtsTransaction

DTS主事务分页对象

被如下接口引用：DescribeDtsTransactions

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

ApplicationAttribute

应用列表其它字段

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

名称	必选	允许NULL	类型	描述
InstanceCount	是	是	Int64	总实例个数示例值：
RunInstanceCount	是	是	Int64	运行实例个数示例值：
GroupCount	是	是	Int64	应用下部署组个数示例值：
RunningGroupCount	否	否	String	运行中部署组个数示例值：
AbnormalCount	否	否	String	异常部署组个数示例值：

ContainerTasks

变更记录任务

被如下接口引用：DescribeContainerTasks、ListContainerTask

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

InterfaceRequest

单条接口请求详情

被如下接口引用：DescribeInterfaceRequest

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

ZipkinEndPoint

调用链Span端点信息

被如下接口引用：GetTraceSpans

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

ResourceFieldRef

k8s env 的 ResourceFieldRef

名称	必选	允许NULL	类型	描述
Resource	否	是	String	k8s 的 Resource 示例值：

ClsLogsetRsp

日志集返回结果

被如下接口引用：DescribeClsLogsets

名称	必选	允许NULL	类型	描述
Logsets	否	是	Array of LogsetInfo	列表示例值：查看
TotalCount	否	是	Int64	数字示例值：
Error	否	是	CloudApiV3Error	返回错误信息示例值：查看

BusinesLogConfigAssociatedGroup

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

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

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

ZipkinBinaryAnnotation

调用链Span二进制注解

被如下接口引用：GetTraceSpans

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

ContainerResourceInfo

容器资源信息

被如下接口引用：DescribeClusterSchedulability

名称	必选	允许NULL	类型	描述
CpuRequest	否	是	String	容器分配的 CPU 核数，对应 K8S 的 request 示例值：
MemRequest	否	是	String	容器分配的内存 MiB 数，对应 K8S 的 request 示例值：

ResourceGetBatchIndexResult

获取执行批次索引的描述

被如下接口引用：GetResourceBatchIndex

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

NamespaceInfos

命名空间id+命名空间name

被如下接口引用：CreateView、DescribeViews

名称	必选	允许NULL	类型	描述
NamespaceId	否	是	String	命名空间id 示例值：
NamespaceName	否	是	String	命名空间名称示例值：

OverviewMsResult

概览页微服务信息

被如下接口引用：DescribeOverviweService

名称	必选	允许NULL	类型	描述
RunMicroserviceCount	是	是	Int64	概览页运行微服务数目（dubbo 的会按 ip 聚合）示例值：
RunMicroserviceInstanceCount	是	是	Int64	概览页微服务在线实例数目示例值：

ZipkinAnnotation

调用链Span注解

被如下接口引用：GetTraceSpans

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

Tag

标签

被如下接口引用：CreateGroup、DeployApplication、DeployContainerApplication、DescribeGroups、DescribeLicenses、DescribeVmGroupRevisionInfo、OperateKubeInject

名称	必选	允许NULL	类型	描述
TagKey	是	是	String	标签键示例值： key1
TagValue	是	是	String	标签值示例值： value1

GetContainGroupDeployInfo

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

被如下接口引用：GetContainGroupDeployInfo

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

DescribeResourceConfigLicense

DescribeResourceConfig

被如下接口引用：DescribeResourceConfig

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

ApmInstanceBriefPage

ApmInstanceBrief的分页

被如下接口引用：DescribeUnassociatedInstances

名称	必选	允许NULL	类型	描述
TotalCount	否	是	Int64	返回总数示例值：
Content	否	是	Array of ApmInstanceBrief	业务系统实例数据示例值：查看

AlarmOverviewContent

告警记录概览页信息

被如下接口引用：DescribeAlarmOverviewList

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

MultiCloudUnitGatewayConfig

超云单元化网关架构配置

被如下接口引用：PushMultiCloudUnitInfo

名称	必选	允许NULL	类型	描述
Id	否	是	String	网关实例ID 示例值：
TsfId	否	是	String	超云TsfId 示例值：
ServiceId	否	是	String	服务ID 示例值：
ServiceName	否	是	String	服务名称示例值：
NamespaceId	否	是	String	命名空间ID 示例值：
NamespaceName	否	是	String	命名空间名称示例值：
AccessMode	否	是	String	访问模式示例值：
Addrs	否	是	Array of String	地址示例值：

DeployApplicationResult

应用部署结果

被如下接口引用：DeployApplication

名称	必选	允许NULL	类型	描述
TaskId	否	是	String	任务Id 示例值：
GroupId	否	是	String	部署组Id 示例值：

FieldRef

容器 env 的 FieldRef

名称	必选	允许NULL	类型	描述
FieldPath	否	是	String	k8s 的 FieldPath 示例值：

CloudSpace

单元化架构

被如下接口引用：CreateAndReleaseArchConfig

名称	必选	允许NULL	类型	描述
CloudSpaceId	否	否	String	云空间 ID 示例值：
CloudId	否	否	String	TCS id 示例值：
CloudName	否	否	String	TCS 名称示例值：
RegionId	否	否	String	地域id 示例值：
RegionName	否	否	String	地域名称示例值：
SDUs	否	否	Array of SDU	SDU 示例值：查看
SDUTrafficRules	否	否	Array of SDUTrafficRule	流量路径示例值：查看
GDUs	否	否	Array of GDU	GDU 示例值：查看
Extensions	否	否	Array of Extension	组件扩展信息示例值：查看
CustomerIdMappingServiceURL	否	否	String	客户号映射服务地址示例值：
CloudSpaceName	否	否	String	云空间名称示例值：
Gateways	否	是	Array of Gateway	单元化网关示例值：查看
UnbindGatewayIds	否	是	Array of String	待解绑的网关 Id 示例值：

Ms

被如下接口引用：CreateAndDownloadTemplate、CreateTemplate

名称	必选	允许NULL	类型	描述
Consumer	是	是	Array of Consumer	Consumer 示例值：查看
MsName	是	是	String	MsName 示例值：
MsPort	是	是	String	MsPort 示例值：
Controller	是	是	Array of Controller	Controller 示例值：查看
Provider	是	是	Array of Provider	Provider 示例值：查看

AlarmInfo

拓扑服务告警信息

被如下接口引用：DescribeNamespaceAlarm

名称	必选	允许NULL	类型	描述
MetricName	是	是	String	指标名示例值：
RestoredCount	是	是	Int64	已恢复的告警条数示例值：
UnRestoredCount	是	是	Int64	未恢复的告警条数示例值：
TotalCount	是	是	Int64	告警总数示例值：
DailyPercent	是	是	Float	日环比示例值：

AlarmReceiverResult

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

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

WeightRouteItemList

权重路由规则项

被如下接口引用：CreateRouteRule、DescribeRouteReleaseHistory

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

TsfPageBusinessLogConfig

业务日志配置项列表

被如下接口引用：DescribeBusinessLogConfigs、DescribeGroupBusinessLogConfigs

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

OverviewResource

资源概览数据信息

被如下接口引用：DescribeOverviewResource

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

GroupUseStatisticsEntity

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

被如下接口引用：DescribeGroupUseDetail

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

TsfPageReleaseTaskRun

发布单任务执行分页信息

被如下接口引用：DescribeReleasePipelineRunTaskStatus

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总数示例值：
Content	是	是	Array of ReleaseTaskRun	任务执行信息列表示例值：查看

CurvePoint

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

被如下接口引用：DescribeJvmMonitor

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

TsfPageResourcePoolInstance

弹性伸缩资源池实例分页对象

被如下接口引用：DescribeResourcePoolInstances

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	总数示例值：
Content	是	是	Array of ResourcePoolInstance	资源池实例列表示例值：查看

AdvanceSettings

高级选项设置

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

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

LogCapacity

analyst 日志限制

被如下接口引用：DescribeLogCapacity

名称	必选	允许NULL	类型	描述
UsedSpace	否	是	Float	已经使用的空间示例值：
Capacity	否	是	Float	总容量示例值：
DeletedSpace	否	是	Float	被删除的空间示例值：

PagedPermCat

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

被如下接口引用：DescribePermissionCategories

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

VmGroup

虚拟机部署组信息

被如下接口引用：DescribeGroup

名称	必选	允许NULL	类型	描述
ServiceSpecEncode	否	是	String	无示例值：
FilebeatCgroupEnable	否	否	Bool	是否开启cgroup控制内存cpu 示例值：
FilebeatMaxCpu	否	是	Float	filebeat使用cpu上限示例值：
UpdateType	是	是	Uint64	滚动发布的更新方式示例值：
ForceStart	否	是	Bool	无示例值：
FilebeatMaxMem	否	是	Int64	filebeat使用内存上限示例值：
RepositoryName	否	是	String	仓库名称示例值：
GroupStatus	是	是	String	部署组状态示例值：
NamespaceName	是	是	String	命名空间名称示例值：
ApplicationName	是	是	String	应用名称示例值：
RunInstanceCount	是	是	Int64	部署组运行中机器数目示例值：
StartupParameters	是	是	String	部署组启动参数信息示例值：
UpdateTime	是	是	String	部署组更新时间示例值：
AgentProfileList	否	是	Array of AgentProfile	javaagent信息示例值：查看
WarmupSetting	否	是	WarmupSetting	预热属性配置示例值：查看
DeployBetaEnable	是	是	Bool	发布是否启用beta批次示例值：
InstanceCount	是	是	Int64	部署组机器数目示例值：
GroupId	是	是	String	部署组ID 示例值：
PackageName	是	是	String	程序包名称示例值：
ClusterId	是	是	String	集群ID 示例值：
ClusterName	是	是	String	集群名称示例值：
NamespaceId	是	是	String	命名空间ID 示例值：
OffInstanceCount	是	是	Int64	部署组停止机器数目示例值：
ApplicationType	是	是	String	应用类型示例值：
DeployDesc	是	是	String	部署应用描述信息示例值：
JdkVersion	否	是	String	无示例值：
IsNotEqualServiceConfig	否	是	Bool	无示例值：
MicroserviceType	是	是	String	微服务类型示例值：
GroupResourceType	是	是	String	部署组资源类型示例值：
DeployWaitTime	是	是	Uint64	滚动发布的每个批次的等待时间示例值：
HealthCheckSettings	是	是	HealthCheckSettings	健康检查配置示例值：查看
StartScript	是	是	String	启动脚本 base64编码示例值：
Alias	否	是	String	部署组备注示例值：
ServiceAgentVersion	否	是	String	无示例值：
Status	否	是	String	无示例值：
DeployExeMode	是	是	String	滚动发布的批次执行方式示例值：
StopScript	是	是	String	停止脚本 base64编码示例值：
GatewayConfig	否	是	GatewayConfig	Envoy网关配置示例值：查看
RepositoryId	否	否	String	仓库ID 示例值：
RepositoryType	否	否	String	仓库类型示例值：
GroupName	是	是	String	部署组名称示例值：
PackageId	是	是	String	程序包ID 示例值：
ApplicationId	是	是	String	应用ID 示例值：
CreateTime	是	是	String	部署组创建时间示例值：
GroupDesc	是	是	String	部署组描述信息示例值：
EnableHealthCheck	是	是	Bool	是否开启了健康检查示例值：
JdkName	否	是	String	无示例值：
EnableBatchHealthCheck	否	是	Bool	批次是否开启健康检查示例值：
PackageVersion	是	是	String	程序包版本号示例值：
UpdatedTime	是	是	Int64	部署组更新时间戳示例值：
DeployBatch	是	是	Array of Float	滚动发布的批次比例列表示例值：
PackageType	是	是	String	程序包类型示例值：
OtAgentVersion	否	是	String	无示例值：
UnitType	否	是	String	无示例值：
Language	否	是	String	无示例值：
BusinessSystemName	否	是	String	无示例值：
UnitName	否	是	String	无示例值：
UnitId	否	是	String	无示例值：
UnitEnvType	否	是	String	无示例值：
K8sNamespaceName	否	是	String	无示例值：
EnabledUnit	否	是	Bool	无示例值：
BusinessSystemId	否	是	String	无示例值：
EnableTelemetry	否	是	Bool	无示例值：
BusinessLogConfigIdList	否	是	Array of String	无示例值：
BusinessLogDeliveryConfigIdList	否	是	Array of String	无示例值：
EnableGovernance	否	是	Bool	无示例值：
NonInvasiveType	否	是	String	无示例值：
FrameworkType	否	是	String	无示例值：
RealNamespaceName	否	是	String	无示例值：
MicroserviceSubType	否	是	String	无示例值：
ClsMachineGroupId	否	是	String	无示例值：
InstanceIdList	否	是	Array of String	无示例值：
Tags	否	是	Array of String	无示例值：
GovernanceType	否	是	String	无示例值：
TapmOtAgentVersion	否	是	String	无示例值：
EnableTelemetryAgent	否	是	Bool	无示例值：
ExclusiveInstances	否	是	Array of String	无示例值：

DeliveryKafkaInfo

kafka投递的topic和path的信息

被如下接口引用：CreateDeliveryConfig、CreateMultiClusterDeliveryConfig、DescribeAssociateRelation、DescribeDeliveryConfig、DescribeDeliveryConfigByGroupId、DescribeDeliveryConfigs、UpdateDeliveryConfig、UpdateMultiClusterDeliveryConfig

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

GatewayQQMiniProgramLoginPlugin

微服务网关qq登录插件

被如下接口引用：DescribeGatewayQQMiniProgramLoginPlugin

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

ApplicationServerResult

被如下接口引用：ListApplicationServers

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

OverviewInstanceResourceUsage

实例相关信息概览

被如下接口引用：DescribeInstanceResourceUsage

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

VolumeClaimTemplateOption

动态PVC模版

被如下接口引用：DeployContainerApplication、DeployContainerGroup、DescribeContainerGroupDeployInfo

名称	必选	允许NULL	类型	描述
StorageClass	否	否	String	存储类型示例值：
StorageRequest	否	否	Int64	存储request 示例值：
AccessModes	否	否	Array of String	读写模式示例值：

InvocationStatisticsRatio

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

被如下接口引用：DescribeInvocationStatisticsRatio

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

ResultStatus

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

被如下接口引用：CreateFlameGraph、SetJvmMonitorMethodProfile

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

ForceSchedule

强制调度配置

被如下接口引用：DeployContainerApplication、DeployContainerGroup、DescribeContainerGroupDeployInfo

名称	必选	允许NULL	类型	描述
AffinityList	否	否	Array of Affinity	- 示例值：查看
AntiAffinityList	否	否	Array of Affinity	- 示例值：查看

InstanceAdvancedSettings

容器导入实例高级设置

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

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

LaneInfo

泳道

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

名称	必选	允许NULL	类型	描述
DeleteDisabledReason	否	否	String	禁用原因示例值：
LaneName	是	是	String	泳道名称示例值：
Remark	是	是	String	泳道备注示例值：
LaneGroupList	是	是	Array of LaneGroup	泳道部署组示例值：查看
LaneId	是	是	String	泳道ID 示例值：
CreateTime	是	是	Int64	创建时间示例值：
UpdateTime	是	是	Int64	更新时间示例值：
Entrance	是	是	Bool	是否入口应用示例值：
NamespaceIdList	是	是	Array of String	泳道已经关联部署组的命名空间列表示例值：
LaneGroupId	否	是	String	泳道部署组ID 示例值：
DeleteDisabled	否	否	Bool	是否禁用删除示例值：

TsfPageMsInstance

微服务实例的分页内容

被如下接口引用：DescribeMicroservice

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

RatelimitRule

限流规则

被如下接口引用：DescribeApiRateLimitRuleList

名称	必选	允许NULL	类型	描述
Id	否	否	String	规则ID 示例值： rate-egvkodao
Name	是	否	String	规则名字，在一个微服务下唯一示例值： rate-app1
Status	否	否	Uint64	状态 0表示启用 1表示停用示例值： 0
SourceService	否	是	String	限流规则区分的来源微服务名示例值： provider-demo
DurationSecond	是	否	Uint64	限流周期，单位秒示例值： 1
DurationQuota	是	否	Uint64	每周期内的限流配额示例值： 1
ModifyTime	否	否	Uint64	最近一次修改规则时间，UTC秒数示例值： 1766145447
Description	否	是	String	描述示例值： this is desc
Dimensions	是	是	Array of RatelimitDimension	限制条件列表示例值：查看
RuleId	否	是	String	rule Id 示例值： rule-69s2rp95
MaxQps	否	是	Uint64	最大限流qps 示例值： 10
UsableStatus	否	是	String	生效/禁用, enabled/disabled 示例值： enabled
TsfRuleId	否	是	String	Tsf Rule ID 示例值： rate-egvkodao
CreatedTime	否	是	String	创建时间示例值： 2025-12-22 17:50:10
UpdatedTime	否	是	String	更新时间示例值： 2025-12-22 17:50:10
Limit	否	是	Int64	分页参数limit 示例值： 20
ApiId	否	是	String	API ID 示例值： api-wox224ox
RuleName	否	是	String	限流名称示例值： gateway-proxy-rule_grp-b1e7ohrw_api-wox224ox
RuleContent	否	是	String	规则内容示例值： this is content
Offset	否	是	Int64	分页参数offset 示例值： 0
AppId	否	是	String	AppId 示例值： 251246729

SimpleNamespace

简单的命名空间信息，含 ID，名称和类型

被如下接口引用：DescribeGeneralMetricDataDimension

名称	必选	允许NULL	类型	描述
NamespaceId	是	是	String	命名空间 ID 示例值：
NamespaceName	是	是	String	命名空间名称示例值：
NamespaceType	是	是	String	命名空间类型示例值：

MonitorGroup

部署组信息，用于云监控

被如下接口引用：DescribeCloudMonitorGroups

名称	必选	允许NULL	类型	描述
ClusterName	是	是	String	集群名称示例值： cls-test
ApplicationId	是	是	String	应用ID 示例值： app-kje
ApplicationName	是	是	String	应用名称示例值： app-demo
NamespaceId	是	是	String	命名空间ID 示例值： ns-hje
GroupDesc	是	是	String	部署组描述信息示例值：测试
GroupName	是	是	String	部署组名称示例值：测试
NamespaceName	是	是	String	命名空间名称示例值：测试
GroupId	是	是	String	部署组ID 示例值： group-ghe
ClusterId	是	是	String	集群ID 示例值： cluster-xe
ApplicationType	否	是	String	应用类型示例值： JAVA
ClusterType	否	是	String	集群类型示例值： V

SDU

标准单元

被如下接口引用：CreateAndReleaseArchConfig

名称	必选	允许NULL	类型	描述
SDUId	否	否	String	SDU id 示例值：
SDUName	否	否	String	SDU 名称示例值：
ZoneId	否	否	String	可用区id 示例值：
ZoneName	否	否	String	可用区名称示例值：
LocalDisasterRecoveryUnitId	否	否	String	同城灾备单元 id 示例值：
RemoteDisasterRecoveryUnitId	否	否	String	异地灾备单元 id 示例值：
CurrentDisasterRecoveryUnitId	否	否	String	当前容灾单元 Id 示例值：
Status	否	否	String	当前容灾状态示例值：
UnitEnvType	否	否	String	单元环境类型- Prod/Gray 示例值：
RemoteDisasterRecoveryCloudSpaceId	否	否	String	异地灾备云空间 id 示例值：

TsfPageUnitRuleV2

单元化规则翻页对象

被如下接口引用：DescribeUnitRulesV2

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	记录总数示例值：
Content	是	是	Array of UnitRule	记录实体列表示例值：查看

ConfigTemplateResult

配置模板列表

被如下接口引用：DescribeConfigTemplates

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

JavaFlameGraph

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

被如下接口引用：DescribeFlameGraph

名称	必选	允许NULL	类型	描述
GzipData	否	是	String	压缩数据示例值：
CreationTime	是	是	String	火焰图创建时间,格式为(yyyy-MM-dd HH:mm:ss),历史无采集成功的火焰图返回"" 示例值：
Status	是	是	String	调用成功success/调用失败error 示例值：
StatusInfo	是	是	String	调用成功为""/调用失败为对应失败信息示例值：
StatusCode	是	是	Int64	调用成功为0/调用失败为对应的错误码示例值：
Compression	否	是	Bool	如果为"true"代表相关数据是压缩后的示例值：
FlameGraphData	是	是	String	火焰图Json,历史无采集成功的火焰图返回"" 示例值：
Duration	是	是	Int64	火焰图采集时长,历史无采集成功的火焰图返回0 示例值：
Event	是	是	String	采集类型示例值：

InvocationStatisticsV2

服务调用统计

被如下接口引用：DescribeInvocationStatistics、DescribeInvocationStatisticsRatio

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

QuantileEntity

分位数据模型

被如下接口引用：DescribeApiUseDetail、DescribeUnitApiUseDetail

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

AgentProfile

部署javaagent的类型、版本信息

名称	必选	允许NULL	类型	描述
AgentVersion	否	否	String	Agent版本号示例值：
AgentType	否	否	String	Agent类型示例值：

RatelimitRuleV2

限流规则

被如下接口引用：CreateRatelimit、DescribeRatelimit

名称	必选	允许NULL	类型	描述
SourceService	否	否	String	限流规则区分的来源微服务名示例值：
DurationQuota	是	否	Uint64	每周期内的限流配额示例值：
Description	否	否	String	描述示例值：
LimitedResponse	否	是	String	降级自定义返回结果，新建或拉取列表时，该字段均为base64编码后的值示例值：
Id	否	否	String	规则ID 示例值：
Status	否	否	Uint64	状态 0表示启用 1表示停用示例值：
DurationSecond	是	否	Uint64	限流周期，单位秒示例值：
ModifyTime	否	否	Uint64	最近一次修改规则时间，UTC秒数示例值：
Dimensions	否	是	Array of RatelimitDimension	限制条件列表示例值：查看
LimitMode	否	否	String	限流类型：集群或者单机示例值：
ConditionModel	否	是	String	限流类型：线程池、qps 示例值：
ConcurrentThreads	否	是	Int64	线程池限流阈值示例值：
Name	是	否	String	规则名字，在一个微服务下唯一示例值：

InstanceSummary

实例监控统计总览

被如下接口引用：DescribeInstanceMetrics

名称	必选	允许NULL	类型	描述
NormalInstances	是	是	Uint64	正常节点数量示例值： 100
AbnormalInstances	是	是	Uint64	异常节点数量示例值： 90
InstancesMetrics	是	是	TsfPageInstanceMetrics	节点监控信息集合示例值：查看

RepositoryList

仓库列表

被如下接口引用：DescribeRepositories

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

SimpleKafkaDeliveryConfig

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

被如下接口引用：DescribeDeliveryConfigByGroupId

名称	必选	允许NULL	类型	描述
CustomRule	否	是	String	无示例值：
EnableGlobalLineRule	否	是	Bool	无示例值：
ConfigName	是	是	String	配置项名称示例值：
KafkaAddress	否	是	String	无示例值：
KafkaVIp	否	是	String	无示例值：
KafkaInfos	否	是	Array of DeliveryKafkaInfo	无示例值：查看
EnableAuth	否	是	Bool	无示例值：
Username	否	是	String	无示例值：
Password	否	是	String	无示例值：
ConfigId	是	是	String	配置项id 示例值：
KafkaVPort	否	是	String	无示例值：
LineRule	否	是	String	无示例值：

ManagerHttp

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

被如下接口引用：DescribeAgentInfo

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

TsfRegion

TSF地域

被如下接口引用：DescribeTsfRegions

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

ThreadDetailInfos

线程详情信息数组

被如下接口引用：DescribeThreadDetailList

名称	必选	允许NULL	类型	描述
Content	是	是	Array of ThreadDetailInfo	线程详情数组示例值：查看
TotalCount	是	是	Int64	接口执行状态success/error 示例值：
Collecting	否	否	Bool	当数据在采集中时，返回true 示例值：
Compression	否	是	String	是否压缩示例值：

ReleaseTaskRun

发布单任务执行状态

被如下接口引用：DescribeReleasePipelineRunTaskStatus

名称	必选	允许NULL	类型	描述
TaskId	是	是	String	任务ID 示例值：
Status	是	是	String	任务执行状态示例值：
StartTime	是	是	Int64	开始时间示例值：
EndTime	是	是	Int64	结束时间示例值：

BusinessSystem

业务系统

被如下接口引用：CreateAndReleaseArchConfig、DescribeUnitBusinessSystems

名称	必选	允许NULL	类型	描述
BusinessSystemId	是	否	String	业务系统id 示例值：
BusinessSystemName	是	否	String	业务系统名称示例值：
BusinessSystemType	否	否	String	业务系统类型，支持 Global, Standard 示例值：

ApiStatusResponse

API在线状态

被如下接口引用：DescribeApiStatus

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

CreateContainerShellSessionResult

CreateContainerShellSession 的 result

被如下接口引用：CreateContainerShellSession

名称	必选	允许NULL	类型	描述
SessionId	是	是	String	session 的标识 id 示例值：

GDU

全局单元

被如下接口引用：CreateAndReleaseArchConfig

名称	必选	允许NULL	类型	描述
GDUId	是	否	String	GDU id 示例值：
GDUName	否	否	String	GDU 名称示例值：
ZoneId	否	否	String	可用区 id 示例值：
ZoneName	否	否	String	可用区名称示例值：
LocalDisasterRecoveryUnitId	否	否	String	同城灾备单元 id 示例值：
RemoteDisasterRecoveryUnitId	否	否	String	异地灾备单元 id 示例值：
CurrentDisasterRecoveryUnitId	否	否	String	当前容灾单元 Id 示例值：
Status	否	否	String	当前容灾状态示例值：
UnitEnvType	否	否	String	单元环境类型- Prod/Gray 示例值：
RemoteDisasterRecoveryCloudSpaceId	否	否	String	异地灾备云空间 id 示例值：
ExcludeZones	否	否	Array of String	排除的可用区Id信息示例值：

PagedProductHelp

产品帮助分组分页对象

被如下接口引用：DescribeProductHelp

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

TsfPageVmTask

虚拟机任务分页信息

被如下接口引用：DscribeTasks

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

CustomTolerateSchedule

自定义容忍调度规则列表

被如下接口引用：DeployContainerApplication、DeployContainerGroup、DescribeContainerGroupDeployInfo

名称	必选	允许NULL	类型	描述
Key	否	否	String	- 示例值：
Operator	否	否	String	- 示例值：
Value	否	否	String	- 示例值：
Effect	否	否	String	- 示例值：
TolerationSeconds	否	否	Int64	- 示例值：

PropertyField

属性字段

被如下接口引用：DescribeApiDetail

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

FindContainerGroupResult

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

被如下接口引用：FindContainerGroup

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

GroupUnitApiUseStatistics

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

被如下接口引用：DescribeUnitApiUseDetail

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

ImageRepositoryResult

镜像仓库列表

被如下接口引用：DescribeImageRepository、ImageGetRepositoryList

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

ImageListResult

镜像列表结果

被如下接口引用：DescribeImages

名称	必选	允许NULL	类型	描述
TotalCount	否	否	Int64	总数示例值：
Content	否	否	Array of ImageInfo	内容示例值：查看

InterfaceStatistic

接口统计

被如下接口引用：DescribeInterfaceStatistic

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

ClsLogConfigModifyResp

cls 日志配置项修改或删除的返回信息

被如下接口引用：DeleteClsConfig、ModifyClsConfig

名称	必选	允许NULL	类型	描述

CommonOption

通用选项

被如下接口引用：DeployContainerApplication、DeployContainerGroup、DescribeContainerGroupDeployInfo

名称	必选	允许NULL	类型	描述
LabelName	否	否	String	- 示例值：
Operator	否	否	String	- 示例值：
LabelValue	否	否	String	- 示例值：

TxError

事务查询异常信息

被如下接口引用：RetryTransaction

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

ZipkinMetadataV2

调用链Span元数据

被如下接口引用：GetOssTraceSpans

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

DtsRetryResp

DTS重试主事务响应

被如下接口引用：RetryTransactions

名称	必选	允许NULL	类型	描述
ErrorList	是	是	Array of DtsRetryError	异常列表示例值：查看

UnitRuleObject

单元化规则

被如下接口引用：DescribeUnitRouteConfig

名称	必选	允许NULL	类型	描述
Id	否	否	String	规则id 示例值： unit-hgkes82s
Name	否	否	String	规则名称示例值： unit_rule
Description	否	是	String	描述示例值： tsf unit rule
UnitRuleItemList	否	否	Array of UnitRouteRuleItem	规则内容示例值：查看
CustomerIdModValue	否	否	String	客户号模除值示例值： 100
UpdatedTime	否	否	String	更新时间戳示例值： 2026-01-01 00:00:00
UpdatedShowTime	否	否	String	更新时间，由UpdatedTime转换而来，用于前端展示示例值： 2026-01-01 00:00:00
CustomerIdTag	否	否	String	客户标签名称示例值： tag_id

TsfPageFileConfig

文件配置项列表

被如下接口引用：DescribeFileConfigSummary、DescribeFileConfigs

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

TsfPageSimpleApplication

TSF分页简单应用对象

被如下接口引用：DescribeSimpleApplications

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

InstanceMetricDataCurve

实例监控数据曲线信息

被如下接口引用：DescribeInstanceMonitorDetails

名称	必选	允许NULL	类型	描述
InstanceMetricData	是	否	Array of MetricDataCurve	指标监控数据曲线集合示例值：查看
InstanceId	是	否	String	节点Id 示例值：
InstanceName	是	否	String	节点名称示例值：

TsfPageMicroserviceSummary

服务治理概要page

被如下接口引用：DescribeMicroServiceSummaryList

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	TotalCount值示例值：
Content	是	是	Array of MicroserviceSummary	Content值示例值：查看

MonitorStatisticsPolicyGroup

被如下接口引用：DescribeMonitorStatisticsPolicy、ListMonitorStatisticsPolicy

名称	必选	允许NULL	类型	描述
GroupId	是	是	String	GroupId 示例值：
GroupDesc	是	是	String	GroupDesc 示例值：
NamespaceId	是	是	String	NamespaceId 示例值：
NamespaceName	是	是	String	NamespaceName 示例值：
ApplicationId	是	是	String	ApplicationId 示例值：
GroupName	是	是	String	GroupName 示例值：
ApplicationName	是	是	String	ApplicationName 示例值：
ClusterId	是	是	String	ClusterId 示例值：
ClusterName	是	是	String	ClusterName 示例值：
ClusterType	否	是	String	ClusterType 示例值： V

IndicatorCoord

监控指标坐标

被如下接口引用：DescribeInovcationIndicators

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

LaneGroups

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

被如下接口引用：DescribeLaneGroups

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

TsfPageReleaseRunInfo

发布单执行信息

被如下接口引用：DescribeReleasePipelineRuns

名称	必选	允许NULL	类型	描述
Content	是	是	Array of ReleaseRunInfo	执行信息列表示例值：查看
TotalCount	是	是	Int64	执行信息总数目示例值：

TsfPageUnitRule

单元化规则翻页对象

被如下接口引用：DescribeUnitRules

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

RouteDestV2

服务路由目标规则

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

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

ResourceBatchOperationStatusResult

描述批次操作的执行结果

被如下接口引用：ContinueResourceBatchOperation

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

GroupInstanceComponentsResult

部署组实例的组件状态返回值

被如下接口引用：DescribeGroupInstanceComponents

名称	必选	允许NULL	类型	描述
InstanceComponents	否	是	Array of InstanceComponent	各个组件的状态信息示例值：查看
EnableLogCollection	否	是	Bool	实例所在集群是否开启 cls（仅限虚拟机集群）示例值：

Release

发布单信息

被如下接口引用：DescribeReleases、DescribeSimpleReleases

名称	必选	允许NULL	类型	描述
ReleaseType	是	是	String	发布单类型示例值：
Status	是	是	String	发布单状态示例值：
Uin	是	是	String	主帐号示例值：
TriggerType	是	是	String	触发类型示例值：
TriggerConfig	是	是	String	触发配置示例值：
TaskCount	是	是	Int64	任务数示例值：
StartTime	是	是	Int64	开始时间示例值：
EndTime	是	是	Int64	结束时间示例值：
Nickname	是	是	String	子帐号昵称示例值：
EnableStatus	是	是	Bool	是否启用示例值：
ReleaseName	是	是	String	发布单名称示例值：
ProgramIds	是	是	Array of String	数据集列表示例值：
SubAccountUin	是	是	String	子帐号示例值：
ReleaseId	是	是	String	发布单ID 示例值：
CreateTime	是	是	Int64	创建时间示例值：
EnableUnitDeploy	否	是	Bool	是否启用单元部署示例值： false
TemplateType	否	是	String	模版类型示例值： batch

StdoutLogV2

标准输出日志

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

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

TsfPageBillingDeal

BillingDeal 翻页对象

被如下接口引用：DescribeBillingDealRecords

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

TsfPageMsRunningApplicationV2

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

被如下接口引用：DescribeMsRunningApplications

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

CloudMonitorPolicyResult

云监控对象策略对象

被如下接口引用：ListCloudMonitorStatisticsPolicy、ListColudMonitorStatisticsPolicy

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	TotalCount 示例值：
Content	是	是	Array of CloudMonitorPolicies	Content 示例值：查看

DeleteImageTag

需要删除的镜像版本

被如下接口引用：DeleteImageTags

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

DescribeResourceConfigLicenseResource

DescribeResourceConfig

被如下接口引用：DescribeResourceConfig

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

PkgList

包列表

被如下接口引用：DescribePkgs、ListPkg

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

PkgBind

描述程序包关联信息

被如下接口引用：DescribePkgs、ListPkg

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

MsApiArray

微服务API数组

被如下接口引用：DescribeInterfaceList、DescribeMsApiList

名称	必选	允许NULL	类型	描述
RpcType	否	是	String	rpc类型：http/dubbo 示例值：
Path	是	否	String	API 请求路径示例值：
Method	是	否	String	请求方法示例值：
Description	否	是	String	方法描述示例值：
Status	是	是	Int64	API状态 0:离线 1:在线示例值：
MsgwApiType	否	是	String	固定值。正常:Normal。示例值：
Uin	否	是	String	用户账号示例值：
MicroserviceId	否	是	String	微服务Id 示例值：
NamespaceId	否	是	String	命名空间Id 示例值：
NamespaceName	否	是	String	命名空间名称示例值：
MicroserviceName	否	是	String	微服务名称示例值：
AppId	否	是	String	租户Id 示例值：
SubAccountUin	否	是	String	子账号示例值：
Id	否	是	String	Id 示例值：

VolumeItem

容器卷挂载项信息

被如下接口引用：DescribeContainerVolumeOptions

名称	必选	允许NULL	类型	描述
Name	否	否	String	无示例值：

Cluster

集群

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

名称	必选	允许NULL	类型	描述
ClusterDesc	是	是	String	集群描述示例值：
TsfRegionId	是	是	String	集群所属TSF地域ID 示例值：
TsfZoneId	是	是	String	集群所属TSF可用区ID 示例值：
GroupCount	否	是	Int64	无示例值：
KuberneteApiServer	否	是	String	无示例值：
KuberneteNativeSecret	否	是	String	无示例值：
ClusterName	是	是	String	集群名称示例值：
RunServiceInstanceCount	是	是	Int64	集群可用的服务实例数量示例值：
KuberneteNativeType	否	是	String	无示例值：
ProgramId	否	是	String	无示例值：
NormalInstanceCount	是	是	Int64	集群正常状态的机器实例数量示例值：
ClusterVersion	是	是	String	集群版本示例值：
InstanceCount	是	是	Int64	集群机器实例数量示例值：
DeleteFlag	是	是	Bool	删除标记：true：可以删除；false：不可删除示例值：
CreateTime	是	是	String	创建时间示例值：
ClusterRemarkName	否	是	String	无示例值：
ProgramIdList	否	是	Array of String	无示例值：
AbnormalGroupCount	否	是	Int64	无示例值：
KubeAuthValid	否	是	Bool	无示例值：
ClusterType	是	是	String	集群类型示例值：
ClusterStatus	是	是	String	集群状态示例值：
UpdateTime	是	是	String	更新时间示例值：
OperationInfo	是	是	OperationInfo	返回给前端的控制信息示例值：查看
MaxNodePodNum	否	是	Int64	无示例值：
Unbind	否	是	Bool	无示例值：
ClusterCIDR	是	是	String	集群CIDR 示例值：
DeleteFlagReason	是	是	String	集群不可删除的原因示例值：
StopGroupCount	否	是	Int64	无示例值：
ClusterTotalCpu	是	是	Float	集群总CPU，单位: 核示例值：
ClusterTotalMem	是	是	Float	集群总内存，单位: G 示例值：
ClusterUsedCpu	是	是	Float	集群已使用CPU，单位: 核示例值：
ClusterUsedMem	是	是	Float	集群已使用内存，单位: G 示例值：
RunInstanceCount	是	是	Int64	集群可用的机器实例数量示例值：
TsfRegionName	是	是	String	集群所属TSF地域名称示例值：
TsfZoneName	是	是	String	集群所属TSF可用区名称示例值：
ClusterLimitMem	是	是	Float	集群最大内存限制，单位：G 示例值：
ClusterId	是	是	String	集群ID 示例值：
VpcId	是	是	String	集群所属私有网络ID 示例值：
ClusterLimitCpu	是	是	Float	集群最大CPU限制，单位：核示例值：
SubnetId	是	是	String	集群所属子网ID 示例值：
MaxClusterServiceNum	否	是	Int64	无示例值：
RunGroupCount	否	是	Int64	无示例值：
ContainerClusterType	否	是	String	容器集群类型示例值：
NativeType	否	是	String	原生集群鉴权类型示例值：
ResourcePoolId	否	是	String	资源池ID 示例值：
TsfZoneIdList	否	是	Array of String	可用区ID列表示例值：
EnabledUnit	否	是	Bool	是否单元化示例值：
SecurityGroupId	否	是	String	安全组ID 示例值：
ReqUrl	否	是	String	废弃字段示例值：
WorkLoadName	否	是	String	废弃字段示例值：
EnableLogCollection	否	是	Bool	是否开启日志采集示例值：
GroupId	否	是	String	废弃字段示例值：
Reason	否	是	String	集群状态理由示例值：
K8sNamespace	否	是	String	废弃字段示例值：

EmptyDirOption

空目录选项

被如下接口引用：DeployContainerApplication、DeployContainerGroup、DescribeContainerGroupDeployInfo

名称	必选	允许NULL	类型	描述
SizeLimit	否	否	String	- 示例值：
EnableMemory	否	否	Bool	- 示例值：
StorageCapacity	否	否	Int64	- 示例值：
StorageUnit	否	否	String	- 示例值：

LaneGroup

泳道部署组

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

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

RepositoryInfo

仓库信息

被如下接口引用：DescribeRepositories、DescribeRepository

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

ReleasePipelineTaskRunRecord

发布单任务执行记录

被如下接口引用：DescribeReleasePipelineTaskRunRecord

名称	必选	允许NULL	类型	描述
RuntimeLog	否	是	String	执行日志示例值：

TemplateResult

被如下接口引用：DescribeTemplates

名称	必选	允许NULL	类型	描述
Content	是	是	Array of TemplateProject	Content 示例值：查看
TotalCount	是	否	Int64	TotalCount 示例值：

GroupDailyUseStatistics

分组日使用统计对象

被如下接口引用：DescribeGroupUseDetail

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

DetectPkgReply

sdk检测结果

被如下接口引用：DetectSdkVersion

名称	必选	允许NULL	类型	描述
PkgSdkVersion	是	否	String	sdk版本示例值： 1.46.0.6-f
UseOT	是	否	String	是否需要使用OT 示例值： YES
OtAgentVersion	否	是	String	OT 版本示例值： 1.15

DailyUseStatistics

日使用统计对象

被如下接口引用：DescribeGatewayDailyUseStatistics

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

EventPolicyResult

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

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

ContainerInfo

容器详细信息

被如下接口引用：DeployContainerApplication、DeployContainerGroup、DescribeContainerGroupDeployInfo

名称	必选	允许NULL	类型	描述
Reason	否	是	String	容器的Reason 示例值：
RepoName	否	是	String	镜像名示例值：
RepoType	否	是	String	仓库类型示例值：
UserEnvs	否	是	Array of Env	环境变量参数示例值：查看
JvmOpts	否	是	String	JVM参数示例值：
InitContainerEnable	否	是	Bool	是否为初始化容器示例值：
IsBusinessMainContainer	否	是	Bool	是否为业务主容器示例值：
CpuLimit	否	是	String	容器Cpu limit 示例值：
Envs	否	是	Array of Env	环境变量参数示例值：查看
PrivilegeContainerEnable	否	是	Bool	是否为特权容器示例值：
TcrRepoInfo	否	是	TcrRepoInfo	TCR 仓库信息示例值：查看
TagName	否	是	String	镜像版本号示例值：
CpuRequest	否	是	String	容器Cpu request 示例值：
LifeCycleHookList	否	是	Array of LifeCycleHook	生命周期钩子示例值：查看
RunCommand	否	是	String	运行命令示例值：
RunArg	否	是	String	运行参数示例值：
GatewayConfig	否	是	GatewayConfig	Envoy网关配置示例值：查看
ContainerName	否	是	String	容器名称示例值：
Name	否	是	String	容器名示例值：
Image	否	是	String	镜像地址示例值：
Server	否	是	String	镜像Server 示例值：
SecretName	否	是	String	容器访问凭证名称示例值：
HealthCheckSettings	否	是	HealthCheckSettings	健康检查示例值：查看
MemRequest	否	是	String	容器Mem request 示例值：
MemLimit	否	是	String	容器Mem Limit 示例值：
VolumeMountInfoList	否	是	Array of VolumeMountInfo	挂载信息示例值：查看
ContainerId	否	是	String	容器ID 示例值：
Status	否	是	String	容器状态示例值：
AllEnvs	否	是	Array of String	环境变量示例值：
AllVolumeMountInfos	否	是	Array of String	volume 示例值：
UserVolumeMountInfos	否	是	Array of String	用户volume 示例值：

DockerForUse

Docker使用指引

被如下接口引用：DescribeDockerForUse、GetDockerForUse

名称	必选	允许NULL	类型	描述
Server	是	否	String	仓库中心地址示例值：
Username	是	否	String	用户名示例值：
Namespace	否	是	String	仓库命名空间示例值：

MetricDataSingleValue

单值指标

被如下接口引用：DescribeInvocationMetricDataPoint

名称	必选	允许NULL	类型	描述
MetricFunction	是	是	String	统计方式示例值：
MetricDataValue	是	是	String	指标值示例值：
DailyPercent	是	是	Float	日环比示例值：
MetricName	是	是	String	指标示例值：

UnitRule

微服务网关单元化规则

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

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

PodContainer

被如下接口引用：DescribePodInstances

名称	必选	允许NULL	类型	描述
MemRequest	否	否	String	容器分配的内存 MiB 数，对应 K8S 的 request 示例值：
MemLimit	否	否	String	容器最大的内存 MiB 数，对应 K8S 的 limit 示例值：
Name	否	是	String	无示例值：
ContainerId	否	是	String	无示例值：
Status	否	是	String	无示例值：
Image	否	是	String	无示例值：
ContainerRestartCount	否	是	Int64	无示例值：
CpuRequest	否	否	String	容器分配的 CPU 核数，对应 K8S 的 request 示例值：
Reason	否	是	String	无示例值：
ImageId	否	是	String	无示例值：
CpuLimit	否	是	String	容器最大的 CPU 核数，对应 K8S 的 limit 示例值：

ConfigRelease

配置项发布信息

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

名称	必选	允许NULL	类型	描述
ConfigId	是	是	String	配置项ID 示例值： dcfg-9ov6lpv3
GroupName	是	是	String	部署组名称示例值： group_app
NamespaceId	是	是	String	命名空间ID 示例值： namespace-96a79v5b
ConfigVersion	是	是	String	配置项版本示例值： v1
ReleaseTime	是	是	String	发布时间示例值： 2024-11-28 18:51:06
GroupId	是	是	String	部署组ID 示例值： group-qevjzabd
ConfigReleaseId	是	是	String	配置项发布ID 示例值： dcfgr-egvkp4yo
ClusterName	是	是	String	集群名称示例值： cls_name
ReleaseDesc	是	是	String	发布描述示例值： This is desc
ApplicationId	是	是	String	应用ID 示例值： application-l6ymbvgd
ConfigCenters	否	是	Array of TsfConfigCenter	配置中心发布情况示例值：查看
DaulStatus	否	是	String	DUAL_STATUS_WRITE_REGISTRATION_ON 双写&&双注册开启 DUAL_STATUS_WRITE_REGISTRATION_OFF 双写&&双注册关闭示例值： DUAL_STATUS_WRITE_REGISTRATION_ON
ConfigName	是	是	String	配置项名称示例值： app_config
NamespaceName	是	是	String	命名空间名称示例值： ns_name
ClusterId	是	是	String	集群ID 示例值： cluster-2vz3nd3a
DualStatus	否	否	String	DUAL_STATUS_WRITE_REGISTRATION_ON 示例值： DUAL_STATUS_WRITE_REGISTRATION_ON

TsfPageRouteReleaseHistoryV2

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

被如下接口引用：DescribeRouteReleaseHistory

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	服务路由部署记录列表总数目示例值： 100
Content	是	是	Array of TsfPageRouteReleaseHistory	服务路由规则部署记录列表信息示例值：查看

UnitRuleTag

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

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

Ports

服务端口

名称	必选	允许NULL	类型	描述
TargetPort	是	否	Uint64	服务端口示例值：
Protocol	是	否	String	端口协议，TCP或者UDP 示例值：

LogsetInfo

日志集信息

被如下接口引用：DescribeClsLogsets

名称	必选	允许NULL	类型	描述
LogsetId	否	是	String	日志集ID 示例值：
LogsetName	否	是	String	日志集名称示例值：
CreateTime	否	是	String	创建时间示例值：
AssumerName	否	是	String	云产品标识，日志集由其它云产品创建时，该字段会显示云产品名称，例如CDN、TKE 示例值：
Tags	否	是	Array of ApmTag	日志集绑定的标签示例值：查看
TopicCount	否	是	String	日志主题个数示例值：
RoleName	否	是	String	角色名称示例值：

AlarmPolicyResult

被如下接口引用：DescribeAlarmPolicy、ListAlarmPolicies

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

ContainerGroupDeploy

获取部署组

被如下接口引用：DescribeContainerGroupDeployInfo

名称	必选	允许NULL	类型	描述
NamespaceName	否	是	String	无示例值：
Reponame	是	是	String	镜像名，如/tsf/nginx 示例值：
ProtocolPorts	是	是	Array of ProtocolPort	端口映射示例值：查看
IstioMemRequest	是	是	String	istioproxy容器初始分配的内存 MiB 数，对应 K8S request 示例值：
ApplicationName	否	是	String	无示例值：
DeployAgent	是	是	Bool	是否部署Agent容器示例值：
RepoType	否	是	String	仓库类型 (person, tcr) 示例值：
ClusterId	否	是	String	无示例值：
IstioCpuLimit	是	是	String	istioproxy容器最大分配的 CPU 核数，对应 K8S limit 示例值：
HeadlessService	否	是	Bool	service 是否为 headless 类型示例值：
AgentProfileList	否	是	Array of AgentProfile	无示例值：查看
AccessType	是	是	Int64	0:公网 1:集群内访问 2：NodePort 示例值：
TcrRepoInfo	否	是	TcrRepoInfo	TcrRepoInfo值示例值：查看
KubeInjectEnable	否	是	Bool	KubeInjectEnable值示例值：
InternalContainerList	否	是	Array of ContainerInfo	内部容器列表示例值：查看
AllowPlainYamlDeploy	否	是	Bool	无示例值：
UpdateType	是	是	Int64	更新方式：0:快速更新 1:滚动更新示例值：
UpdateIvl	是	是	Int64	更新间隔,单位秒示例值：
AgentCpuLimit	是	是	String	agent容器最大分配的 CPU 核数，对应 K8S limit 示例值：
ContainerName	否	是	String	容器名称示例值：
CurrentNum	是	是	Int64	已启动实例总数示例值：
TagName	是	是	String	镜像版本名称示例值：
MemRequest	是	是	String	业务容器初始分配的内存 MiB 数，对应 K8S request 示例值：
AgentMemRequest	是	是	String	agent容器初始分配的内存 MiB 数，对应 K8S request 示例值：
VolumeInfos	否	是	Array of VolumeInfo	数据卷信息，数组结构示例值：查看
ApplicationId	否	是	String	无示例值：
MicroserviceType	否	是	String	无示例值：
CpuRequest	是	是	String	业务容器初始分配的 CPU 核数，对应 K8S request 示例值：
SessionAffinityTimeoutSeconds	否	是	Int64	无示例值：
SchedulingStrategy	否	是	SchedulingStrategy	无示例值：查看
SubnetId	是	是	String	子网id 示例值：
AgentCpuRequest	是	是	String	agent容器初始分配的 CPU 核数，对应 K8S request 示例值：
AgentMemLimit	是	是	String	agent容器最大分配的内存 MiB 数，对应 K8S limit 示例值：
IstioMemLimit	是	是	String	istioproxy容器最大分配的内存 MiB 数，对应 K8S limit 示例值：
Alias	否	是	String	部署组备注示例值：
VolumeMountInfos	否	是	Array of VolumeMountInfo	数据卷挂载信息，list 示例值：查看
RepoName	否	是	String	无示例值：
UserEnvs	否	是	Array of EnvsV2	无示例值：查看
MaxSurge	否	是	String	无示例值：
AdditionalContainerList	否	是	Array of ContainerInfo	附加容器列表示例值：查看
InstanceNum	是	是	Int64	实例总数示例值：
CpuLimit	是	是	String	业务容器最大分配的 CPU 核数，对应 K8S limit 示例值：
DisableService	否	是	Bool	是否创建 k8s service 示例值：
SecretName	否	是	String	无示例值：
ApplicationType	否	是	String	无示例值：
NamespaceId	否	是	String	无示例值：
GroupName	是	是	String	分组名称示例值：
JvmOpts	是	是	String	jvm参数示例值：
Envs	是	是	Array of Env	部署组的环境变量数组，这里没有展示 tsf 使用的环境变量，只展示了用户设置的环境变量。示例值：查看
HealthCheckSettings	是	是	HealthCheckSettings	健康检查配置信息，若不指定该参数，则默认不设置健康检查。示例值：查看
GatewayConfig	否	是	GatewayConfig	Envoy网关服务配置示例值：查看
ClusterName	否	是	String	无示例值：
MaxUnavailable	否	是	String	无示例值：
ServiceSettingList	否	是	Array of ServiceSetting	service列表示例值：查看
GroupId	是	是	String	部署组id 示例值：
Server	是	是	String	镜像server 示例值：
MemLimit	是	是	String	业务容器最大分配的内存 MiB 数，对应 K8S limit 示例值：
IstioCpuRequest	是	是	String	istioproxy容器初始分配的 CPU 核数，对应 K8S request 示例值：
CreateTime	否	是	String	无示例值：
WarmupSetting	否	是	WarmupSetting	预热配置设置示例值：查看
OpenSessionAffinity	否	是	Bool	无示例值：
StaticIpEnabled	否	是	Bool	无示例值：
LbDns	否	是	String	无示例值：
RunCommand	否	是	String	运行命令(转base64) 示例值：
ContainerKind	否	是	String	无示例值：
VolumeInfoList	否	是	String	容器卷信息示例值：
TsfDefaultEnvs	否	是	Array of String	无示例值：
PodManagementPolicyType	否	是	String	无示例值：
RestartPolicy	否	是	String	无示例值：
CpClusterId	否	是	String	无示例值：
LifeCycleHookList	否	是	Array of LifeCycleHook	无示例值：查看
K8sNamespaceName	否	是	String	无示例值：
VolumeMountInfoList	否	是	String	无示例值：
ClusterIp	否	是	String	无示例值：
PublishStrategy	否	是	String	无示例值：
UpdatedNum	否	是	Int64	无示例值：
Partition	否	是	Int64	无示例值：
ImagePullSecretList	否	是	Array of String	无示例值：
RunArg	否	是	String	无示例值：
DeployDesc	否	是	String	无示例值：
ObservabilityConfig	否	是	ContainerGroupObservabilityConfig	无示例值：查看
PrivilegeContainerEnable	否	是	Bool	无示例值：
ServiceGovernanceConfig	否	是	ContainerGroupServiceGovernanceConfig	无示例值：查看

ProgramItem

tsf-privilege模块，数据项

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

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

TsfPageMonitorGroup

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

被如下接口引用：DescribeCloudMonitorGroups

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

Error

检测sdk版本错误信息

被如下接口引用：DetectSdkVersion

名称	必选	允许NULL	类型	描述
Code	否	否	String	错误码示例值： 00001
Message	否	否	String	错误信息示例值：参数错误

GraphNodeV2

依赖拓扑图节点

被如下接口引用：GetOssTopologyGraph、GetTopologyGraph

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

CosCredentials

cos临时账号信息

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

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

InstanceResourceConfig

实例相关的参数配置

被如下接口引用：DescribeResourceConfig

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

DescribeResourceConfigCluster

返回给前端的控制信息

被如下接口引用：DescribeResourceConfig

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

TsfPageNamespace

Tsf命名空间分页对象

被如下接口引用：DescribeNamespaces、DescribeSimpleNamespaces

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

Role

tsf-privilege模块 Role 角色

被如下接口引用：DescribeRole、DescribeRoles

名称	必选	允许NULL	类型	描述
PermCatList	否	是	Array of PermCat	角色权限集列表示例值：查看
CreationTime	否	是	Int64	创建时间示例值：
LastUpdateTime	否	是	Int64	最后更新时间示例值：
RoleId	否	是	String	角色ID 示例值：
RoleName	否	是	String	角色名称示例值：
RoleDesc	否	是	String	角色描述示例值：
DeleteFlag	否	是	Bool	删除标识示例值：
AppId	否	是	String	公有云APP ID 示例值：
SubAccountUin	否	是	String	公有云用户唯一ID 示例值：
Uin	否	是	String	公有云APP Owner的用户唯一ID 示例值：

ClusterV2

集群详情

被如下接口引用：DescribeCluster、DescribeClusterGroupCount、DescribeClusterInstanceCount、DescribeClusters

名称	必选	允许NULL	类型	描述
ClusterName	是	是	String	集群名称示例值：
ClusterType	是	是	String	集群类型，C表示容器集群，V表示虚拟机集群示例值：
ClusterStatus	是	是	String	集群状态示例值：
KuberneteApiServer	否	是	String	api地址示例值：
KuberneteNativeType	否	是	String	K 表示通过kubeconfig 导入, S 表示通过service account导入示例值：
ProgramId	否	是	String	无示例值：
Unbind	否	是	Bool	无示例值：
ClusterTotalMem	是	是	Float	集群总内存，单位: G 示例值：
DeleteFlag	是	是	Bool	删除标记：true：可以删除；false：不可删除示例值：
ClusterLimitMem	是	是	String	集群剩余 memory limit 示例值：
RunInstanceCount	是	是	Int64	集群运行中的机器实例数量示例值：
ClusterId	是	是	String	集群ID 示例值：
ClusterCIDR	是	是	String	集群CIDR 示例值：
NormalInstanceCount	是	是	Int64	集群正常状态的机器实例数量示例值：
UpdateTime	是	是	String	更新时间，格式为YYYY-MM-DD HH:MM:SS 示例值：
TsfRegionName	是	是	String	集群所属TSF地域名称示例值：
SubnetId	是	是	String	集群所属私有网络子网ID 示例值：
GroupCount	是	是	Uint64	部署组总数示例值：
VpcId	是	是	String	集群所属私有网络ID 示例值：
ClusterVersion	是	是	String	容器集群版本示例值：
KubeAuthValid	否	是	Bool	无示例值：
Reason	否	是	String	集群状态的原因示例值：
ClusterUsedMem	是	是	Float	集群已使用内存，单位: G 示例值：
CreateTime	是	是	String	创建时间，格式为YYYY-MM-DD HH:MM:SS 示例值：
TsfRegionId	是	是	String	集群所属TSF地域ID 示例值：
TsfZoneName	是	是	String	集群所属TSF可用区名称示例值：
DeleteFlagReason	是	是	String	集群不可删除的原因示例值：
MaxNodePodNum	否	是	Int64	无示例值：
OperationInfo	是	是	OperationInfo	给前端的按钮控制信息示例值：查看
ClusterDesc	是	是	String	集群描述示例值：
ClusterUsedCpu	是	是	Float	集群已使用CPU，单位: 核示例值：
TsfZoneId	是	是	String	集群所属TSF可用区ID 示例值：
ClusterLimitCpu	是	是	String	集群剩余 cpu limit 示例值：
RunServiceInstanceCount	是	是	Int64	运行服务实例数示例值：
RunGroupCount	是	是	Uint64	运行中部署组数示例值：
AbnormalGroupCount	是	是	Uint64	异常部署组数示例值：
ClusterTotalCpu	是	是	Float	集群总CPU，单位: 核示例值：
InstanceCount	是	是	Int64	集群机器实例数量示例值：
StopGroupCount	是	是	Uint64	停止中部署组数示例值：
ClusterRemarkName	是	是	String	集群备注名示例值：
KuberneteNativeSecret	否	是	String	native secret 示例值：
ProgramIdList	否	是	Array of String	无示例值：
MaxClusterServiceNum	否	是	Int64	无示例值：
EnableLogCollection	否	是	Bool	是否开启cls日志功能示例值：
ClusterCpuType	否	是	String	集群cpu架构示例值：
DisableProgramAuthCheck	否	是	Bool	关闭数据集校验示例值：
EnabledUnit	否	是	Bool	是否开启单元化部署示例值：
SecurityGroupId	否	是	String	安全组ID 示例值：
TsfZoneIdList	否	是	String	TSF可用区ID列表示例值：
ResourcePoolId	否	是	String	资源池ID 示例值：
ContainerClusterType	否	是	String	容器集群类型示例值：
Language	否	是	String	语言示例值：
CamContext	否	是	String	云API访问密钥示例值：
CpClusterIdsMap	否	是	String	批量接口查询用，key 是 clusterId，value 是 cpClusterId 示例值：
UserID	否	是	String	用户ID 示例值：
KuberneteToken	否	是	String	kubernete_token 示例值：
Filters	否	是	String	过滤条件示例值：
GrafanaUrl	否	是	String	pod运行监控URL 示例值：
ClientIp	否	是	String	ClientIP 示例值：
K8sNamespace	否	是	String	废弃字段示例值：
ReqUrl	否	是	String	废弃字段示例值：
GroupId	否	是	String	废弃字段示例值：
WorkLoadName	否	是	String	废弃字段示例值：

TrySchedule

尽量调度

被如下接口引用：DeployContainerApplication、DeployContainerGroup、DescribeContainerGroupDeployInfo

名称	必选	允许NULL	类型	描述
AffinityList	否	否	Array of Affinity	- 示例值：查看
AntiAffinityList	否	否	Array of Affinity	- 示例值：查看

SpanLabel

Span标签

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

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

Metric

指标

被如下接口引用：DescribeGatewayMonitorDetails、DescribeInstanceMonitorDetails、DescribeInvocationMetricDataCurve、DescribeInvocationMetricDataPoint、DescribeInvocationMetricScatterPlot

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

RouteAffinity

路由规则就近访问策略

被如下接口引用：DescribeNamespaceAffinities

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

ModuleParamResult

ModuleParamResult值

被如下接口引用：FindDeployModuleParams

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

GroupApiUseStatistics

API监控明细数据

被如下接口引用：DescribeApiUseDetail

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

ThreadDump

DescribeThreadDump 接口返回的数据列表

被如下接口引用：DescribeThreadDump

名称	必选	允许NULL	类型	描述
StatusInfo	是	是	String	success时为"", error时为错误信息示例值：
StatusCode	是	是	Int64	success时为, error时为错误码示例值：
Collecting	否	否	Bool	monitor采集数据BUSY时，返回true 示例值：
Data	是	是	Array of ThreadDumpData	线程分析结果示例值：查看
Status	是	是	String	接口执行状态success/error 示例值：

ResourceNodeStatus

模块节点的资源使用情况

被如下接口引用：DescribeResourceUsageRate

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

ScalableRule

ScalableRule值

被如下接口引用：DescribeImageRepository、ImageGetRepositoryList、ListScalableRule

名称	必选	允许NULL	类型	描述
Name	是	是	String	Name值示例值：
ExpandVmCountLimit	是	是	Int64	ExpandVmCountLimit值示例值：
ShrinkVmCountLimit	是	是	Int64	ShrinkVmCountLimit值示例值：
DisableMetricAS	否	是	Uint64	是否关闭指标伸缩, 默认0, 0:打开指标伸缩 1:关闭指标伸缩示例值：
RuleId	是	是	String	RuleId值示例值：
GroupCount	是	是	Int64	GroupCount值示例值：
Desc	否	是	String	备注示例值：
Description	否	是	String	备注示例值：
EnableCronAS	否	是	Uint64	开启定时伸缩规则, 默认0, 0:关闭定时伸缩 1:开启定时伸缩示例值：

BusinessLogConfigSchema

业务日志配置解析规则

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

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

ReleaseRunInfo

发布单执行信息

被如下接口引用：DescribeReleasePipelineRuns

名称	必选	允许NULL	类型	描述
Status	是	否	String	执行状态示例值：
TriggerType	是	否	String	触发类型示例值：
TaskCount	是	否	Int64	任务数示例值：
StartTime	是	否	Int64	开始时间示例值：
EndTime	是	是	Int64	结束时间示例值：
Uin	是	是	String	主帐号示例值：
SubAccountUin	是	是	String	子帐号示例值：
Nickname	是	是	String	昵称示例值：
RunId	是	否	String	执行ID 示例值：

JvmLog

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

被如下接口引用：DescribeJvmLogs

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

LogCollectionDetail

cls日志详情

被如下接口引用：DescribeLogCollection

名称	必选	允许NULL	类型	描述
LogListenerStatus	否	是	String	cls日志状态示例值：
AbnormalReason	否	是	String	异常原因示例值：
EnableLogCollection	否	是	Bool	是否开启cls日志示例值：

MsRunningApplicationV2

微服务应用信息

被如下接口引用：DescribeMsRunningApplications

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

TsfPageImageFeature

镜像特征列表

被如下接口引用：DescribeImageFeatures

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

TsfPageConfig

TsfPage

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

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

DescribeResourceConfigClusterContainer

返回给前端的控制信息

被如下接口引用：DescribeResourceConfig

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

PagedRole

tsf-privilege 模块分页的Role列表

被如下接口引用：DescribeRoles

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

VmSubTask

虚拟机子任务信息

被如下接口引用：DescribeSubTasks

名称	必选	允许NULL	类型	描述
TaskRecord	是	是	String	任务记录示例值： deploying
WanIp	是	是	String	外网IP 示例值： 127.0.0.1
InstanceName	是	是	String	机器名称示例值： insxxx
TaskStatus	是	是	Int64	任务状态示例值： 0
Reason	是	是	String	异常理由示例值： null
InstanceId	是	是	String	机器Id 示例值： ins-123
LanIp	是	是	String	内网IP 示例值： 127.0.0.1
AgentState	是	是	Int64	机器Agent状态示例值： 0
InstanceState	是	是	Int64	机器状态示例值： 0
PackageVersion	是	是	String	包版本信息示例值： 20260404

RecordV2

操作记录对象

被如下接口引用：DescribeRecords

名称	必选	允许NULL	类型	描述
OperationMsg	是	是	String	操作记录描述示例值：
OperationTime	是	是	String	操作记录时间示例值：
ModuleType	是	是	String	模块类型示例值：
OperationStatus	是	是	String	操作状态示例值：
Operator	是	是	String	操作人示例值：
Nickname	是	是	String	昵称示例值：
ElapsedTime	是	是	Int64	耗时示例值：
AppId	是	是	String	账号AppId 示例值：
Uin	是	是	String	账号Uin 示例值：
SubAccountUin	是	是	String	账号SubAccountUin 示例值：
RecordId	是	是	String	操作记录Id 示例值：
OperationType	是	是	String	操作类型示例值：
OperationResource	是	是	String	操作资源信息示例值：
OperationIp	是	是	String	操作人远程Ip 示例值：
OperationExtColumn	是	是	String	需要新增的字段描述示例值：

ContainerEvent

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

被如下接口引用：DescribeContainerEvents

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

Person

tsf告警策略的接收者

被如下接口引用：CreateAlarmPolicy

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

SimpleResult

是否成功；失败原因

被如下接口引用：TestKuberneteNativeConnection

名称	必选	允许NULL	类型	描述
Success	是	是	Bool	是否成功示例值：
Message	是	是	String	失败原因示例值：

CloudMonitorPolicies

云监控对象策略对象

被如下接口引用：ListCloudMonitorStatisticsPolicy、ListColudMonitorStatisticsPolicy

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

TsfPageGatewayDeployGroup

GatewayDeployGroup 翻页对象

被如下接口引用：DescribeGroupBindedGateways、DescribeUsableGatewayGroups

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

TsfPageGatewayPlugin

GatewayPlugin 翻页对象

被如下接口引用：DescribeGatewayPlugins、DescribePluginInstances

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

MicroserviceGroup

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

被如下接口引用：DescribeMicroserviceGroups

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

ServiceConfig

服务配置

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

TsfJvmLogPage

Jvm日志查询返回数据封装

被如下接口引用：DescribeJvmLogs

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

GatewayApiGroupVo

网关分组简单信息

被如下接口引用：DescribeGatewayAllGroupApis

名称	必选	允许NULL	类型	描述
GatewayInstanceId	是	是	String	网关实例ID 示例值：
GroupId	是	是	String	分组ID 示例值：
GroupName	是	是	String	分组名称示例值：
GroupApiCount	是	是	Uint64	分组下API个数示例值：
GroupApis	是	是	Array of GatewayGroupApiVo	分组API列表示例值：查看
GatewayInstanceType	是	是	String	网关实例的类型示例值：

MemoryPicture

Jvm监控内存数据封装

被如下接口引用：DescribeJvmMonitor

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

TaskSpec

任务Spec

被如下接口引用：DescribeReleasePipeline、DescribeReleasePipelineRun、DescribeReleasePipelineTask、ModifyReleasePipeline、ModifyReleasePipelineTask

名称	必选	允许NULL	类型	描述
TaskType	是	否	String	任务类型示例值：
Payload	否	是	String	任务参数map 示例值：
DisableRollback	否	是	Bool	是否回滚示例值：
TaskId	是	否	String	任务ID 示例值：
Dependencies	否	是	Array of String	任务ID依赖列表示例值：
NeedConfirm	否	是	Bool	是否需要手动确认示例值：
TimeOut	否	是	Uint64	任务执行的总时间示例值：

TsfPageVmSubTask

虚拟机子任务分页信息

被如下接口引用：DescribeSubTasks

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

LicenseTag

许可标签

被如下接口引用：DescribeLicenses

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

VmGroupOther

虚拟机部署组其他字段

被如下接口引用：DescribeGroupAttribute、DescribeGroupOther

名称	必选	允许NULL	类型	描述
GroupId	是	是	String	部署组ID 示例值：
PackageName	是	是	String	程序包名称示例值：
InstanceCount	是	是	Int64	部署组实例数示例值：
RunInstanceCount	是	是	Int64	部署组运行中实例数示例值：
OffInstanceCount	是	是	Int64	部署组中停止实例数示例值：
GroupStatus	是	是	String	部署组状态，Running运行中，Waiting等待中，Paused暂停中，Updating更新中，RollingBack回滚中，Abnormal异常，Unknown未知示例值：
IsNotEqualServiceConfig	是	是	Bool	服务配置信息是否匹配示例值：
PackageType	否	是	String	PackageType 示例值：
PackageId	是	是	String	程序包ID 示例值：
PackageVersion	是	是	String	程序包版本示例值：
EnableHealthCheck	否	是	Bool	EnableHealthCheck 示例值：
HealthCheckSettings	否	是	HealthCheckSettings	HealthCheckSettings 示例值：查看
RepositoryType	否	是	String	RepositoryType 示例值：
RepositoryName	否	是	String	RepositoryName 示例值：
RepositoryId	否	是	String	RepositoryId 示例值：

TsfPageMicroservice

微服务列表信息

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

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

Env

环境变量

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

名称	必选	允许NULL	类型	描述
Name	是	否	String	环境变量名称示例值：
Value	是	是	String	环境变量值示例值：
ValueFrom	否	是	ValueFrom	k8s ValueFrom 示例值：查看

ListApplicationServerResult

被如下接口引用：ListApplicationServers

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	TotalCount 示例值：
Content	是	是	Array of ApplicationServerResult	Content 示例值：查看

GenerateSignAuth

计费下单签名详情

被如下接口引用：DescribeBillingAuthSign

名称	必选	允许NULL	类型	描述
SecretId	否	否	String	密钥示例值：
Timestamp	否	否	Uint64	时间戳示例值：
Nonce	否	否	String	签名随机字符串示例值：
Signature	否	否	String	签名示例值：
Version	否	否	String	版本号示例值：

OverviewBasicResourceUsage

TSF基本资源信息概览

被如下接口引用：DescribeBasicResourceUsage

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

DU

单元信息

被如下接口引用：DescribeDeploymentUnits、DescribeUnitsByBusinessSystemIds

名称	必选	允许NULL	类型	描述
UnitId	否	否	String	单元id 示例值： unit-jskuesh2hs
UnitName	否	是	String	单元名称示例值：单元Ａ
ZoneId	否	是	String	可用区id 示例值： bj-01
ZoneName	否	是	String	可用区名称示例值： unit-03
UnitType	否	否	String	单元类型 Global 代表 GDU，Standard 代表 SDU 示例值： Standard
UnitEnvType	否	否	String	单元环境类型 Prod/Gray 示例值： Prod

TsfPageLicenseTag

LicenseTag 翻页对象

被如下接口引用：DescribeLicenses

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

TsfPageClsLogConfig

cls 分页resp

被如下接口引用：DescribeClsConfig

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	3 示例值：
Content	是	是	Array of ClsLogConfig	gasdf 示例值：查看

UserProgramValue

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

名称	必选	允许NULL	类型	描述
FilebeatConfig	否	是	Array of String	Filebeat 示例值：
Lane	否	是	Array of String	泳道示例值：
Microservice	否	是	Array of String	为服务示例值：
AlarmPolicy	否	是	Array of String	告警示例值：
Gateway	否	是	Array of String	网关示例值：
DeliveryConfig	否	是	Array of String	Delivery 示例值：
Release	否	是	Array of String	发布计划示例值：
LaneRule	否	是	Array of String	泳道示例值：
FileConfig	否	是	Array of String	文件配置示例值：
Plugin	否	是	Array of String	插件示例值：
Config	否	是	Array of String	应用配置示例值：
PubConfig	否	是	Array of String	全局配置示例值：
Cluster	否	是	Array of String	集群示例值：
Log	否	是	Array of String	日志示例值：
Task	否	是	Array of String	任务示例值：
TaskFlow	否	是	Array of String	任务示例值：
ConfigTemplate	否	是	Array of String	配置模板示例值：
Group	否	是	Array of String	部署组示例值：
Application	否	是	Array of String	应用示例值：
ScalableRule	否	是	Array of String	Scalable 示例值：
Namespace	否	是	Array of String	命名空间示例值：

Controller

tsf模板

被如下接口引用：CreateAndDownloadTemplate、CreateTemplate

名称	必选	允许NULL	类型	描述
ControllerName	是	是	String	ControllerName 示例值：

Instance

机器实例

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

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

TsfPageMicroServiceMetas

分页元数据结构

被如下接口引用：DescribeMicroserviceMetas

名称	必选	允许NULL	类型	描述
TotalCount	否	否	Int64	条数示例值：
Content	否	否	Array of MicroServiceMetas	元数据示例值：查看

Microservice

微服务

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

名称	必选	允许NULL	类型	描述
MicroserviceDesc	否	是	String	微服务描述示例值： desc of ms
CreateTime	否	是	Int64	创建时间示例值： 2026-01-01 00:00:00
UpdateTime	否	是	Int64	更新时间示例值： 2026-01-01 00:00:00
NamespaceId	否	是	String	命名空间ID 示例值： namespace-96a79v5b
RunInstanceCount	否	是	Int64	微服务的运行实例数目示例值： 106
CriticalInstanceCount	否	是	Int64	微服务的离线实例数目示例值： 102
MicroserviceId	否	是	String	微服务ID 示例值： ms-67c57847d
MicroserviceName	否	是	String	微服务名称示例值： ms-name
SubAccountUin	否	是	String	sub uin 示例值： 20250908110011
NamespaceName	否	是	String	命名空间名称示例值： ns-app
AppId	否	是	String	App id 示例值： 1255000100
Uin	否	是	String	uin 示例值： 20250908110011
GroupIds	否	是	Array of String	部署组 id 列表示例值： ["group-xoydmy26"]

TsfPageZipkinSpanInfo

调用链Span列表

被如下接口引用：GetTraceSpans

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

TsfPageSimpleGroup

TSF简单部署组分页列表

被如下接口引用：DescribeSimpleGroups

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

BusinessLogV2

业务日志

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

DescribeSingleContainerGroups

部署组-独立菜单

被如下接口引用：DescribeSingleContainerGroups

名称	必选	允许NULL	类型	描述
ClusterId	是	是	String	集群id 示例值： cluster-123xxx
ClusterName	是	是	String	集群名称示例值： cls-prod
CpuRequest	是	是	String	初始分配的 CPU 核数，对应 K8S request 示例值： 0.2
SubnetId	是	是	String	子网id 示例值： subnet-qwexxx
GroupResourceType	是	是	String	部署组资源类型示例值： DEF
KubeInjectEnable	是	是	Bool	KubeInjectEnable值示例值： false
UpdateIvl	是	是	Int64	更新时间间隔示例值： 10
Envs	是	是	String	环境变量示例值：无
GroupId	否	是	String	部署组id 示例值： group-qwexxx
GroupName	否	是	String	分组名称示例值： consumer-demo
NamespaceName	是	是	String	命名空间名称示例值： ns-name
ApplicationName	是	是	String	应用类型示例值： C
MemLimit	是	是	String	最大分配的内存 MiB 数，对应 K8S limit 示例值： 1000
ProtocolPorts	是	是	Array of ProtocolPort	端口列表示例值：查看
Server	是	是	String	镜像server 示例值： xxx.dockerxx.com
TagName	是	是	String	镜像版本名称示例值： v1
AccessType	是	是	Int64	网络访问类型示例值： 1
CpuLimit	否	是	String	最大分配的 CPU 核数，对应 K8S limit 示例值： 2
NamespaceId	是	是	String	命名空间id 示例值： namespace-123xxx
ApplicationType	是	是	String	分组创建时间示例值： 2026-03-19 11:57:10
MicroserviceType	是	是	String	微服务类型示例值： N
UpdateType	是	是	Int64	更新类型示例值： 1
InstanceCount	是	是	Int64	实例个数示例值： 1
UpdatedTime	是	是	Int64	部署组更新时间戳示例值： 2026-03-19 11:57:10
Alias	是	是	String	备注示例值： this is a desc
Reponame	是	是	String	镜像名，如/tsf/nginx 示例值： /tsf/nginx
MemRequest	是	是	String	初始分配的内存 MiB 数，对应 K8S request 示例值： 300
ApplicationId	是	是	String	应用名称示例值： consumer-demo
CreateTime	是	是	String	创建时间示例值： 2026-03-19 11:57:10
UnitType	否	否	String	单元类型示例值： global
UnitEnvType	否	否	String	单元环境类型示例值： prod
UnitId	否	是	String	单元ID 示例值： s001
BusinessSystemId	否	是	String	业务系统 id 示例值： consumer-demo
EnabledUnit	否	是	Bool	是否开启单元化示例值： false
K8sNamespaceName	否	是	String	k8s命名空间名称示例值： k8s-ns-name
BusinessSystemName	否	是	String	业务系统名称示例值： consumer-demo
UnitName	否	是	String	单元名称示例值： unit-name
RepoName	否	是	String	镜像仓库名称示例值： /tsf/nginx
Status	否	是	String	状态示例值： Running
InstanceNum	否	是	Int64	实例数量示例值： 1
CurrentNum	否	是	Int64	当前实例数量示例值： 1

RouteRule

路由规则信息

被如下接口引用：DescribeRouteReleaseHistory

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

LifeCycleHook

被如下接口引用：DeployContainerApplication、DeployContainerGroup、DescribeContainerGroupDeployInfo

名称	必选	允许NULL	类型	描述
HookType	否	是	String	生命周期函数类型：PostStart
ExecMode	否	是	String	函数执行方式：execCommand
ExecCommandContent	否	是	String	execCommand函数执行内容示例值：
HttpGetOption	否	是	HttpGetOption	HttpGet执行内容示例值：查看

PagedService

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

被如下接口引用：DescribeServices

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

InstanceInfo

实例信息

被如下接口引用：DescribeInterfaceRequest

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

KubeDeploymentPage

容器轻量化Deployment Page

被如下接口引用：DescribeKubeDeployments

名称	必选	允许NULL	类型	描述
IsSetup	是	是	Bool	IsSetup值示例值：
TotalCount	是	是	Int64	TotalCount值示例值：
Content	是	是	Array of KubeDeployment	Content值示例值：查看

VolumeInfo

容器卷挂载信息

被如下接口引用：DeployContainerApplication、DeployContainerGroup、DescribeContainerGroupDeployInfo

名称	必选	允许NULL	类型	描述
VolumeType	是	否	String	数据卷类型示例值：
VolumeName	是	否	String	数据卷名称示例值：
VolumeConfig	否	否	String	数据卷配置示例值：
ConfigMapOptions	否	否	Array of ConfigMapOption	- 示例值：查看
EmptyDirOption	否	否	EmptyDirOption	- 示例值：查看
VolumeClaimTemplateOption	否	否	VolumeClaimTemplateOption	动态pvc配置示例值：查看

ConfigReleaseLog

配置项发布日志

被如下接口引用：DescribeConfigReleaseLogs、DescribePublicConfigReleaseLogs

名称	必选	允许NULL	类型	描述
ReleaseStatus	是	是	String	发布状态示例值：
ConfigId	是	是	String	配置项ID 示例值：
ConfigVersion	是	是	String	配置项版本示例值：
NamespaceName	是	是	String	命名空间名称示例值：
ReleaseDesc	是	是	String	发布描述示例值：
LastConfigName	是	是	String	上次发布的配置项名称示例值：
ConfigName	是	是	String	配置项名称示例值：
LastConfigId	是	是	String	上次发布的配置项ID 示例值：
LastConfigVersion	是	是	String	上次发布的配置项版本示例值：
ConfigReleaseLogId	是	是	String	配置项发布日志ID 示例值：
GroupName	是	是	String	部署组名称示例值：
ClusterName	是	是	String	集群名称示例值：
ReleaseTime	是	是	String	发布时间示例值：
RollbackFlag	是	是	Bool	回滚标识示例值：
GroupId	是	是	String	部署组ID 示例值：
NamespaceId	是	是	String	命名空间ID 示例值：
ClusterId	是	是	String	集群ID 示例值：
ReleasedConfigCenter	否	是	String	发布成功的配置中心 ALL/EXCLUSIVE/SHARE/NONE 全部发布成功，独占发布成功，共享发布成功，全部发布失败示例值：

TaskPhaseInfo

任务阶段信息

被如下接口引用：DescribeTaskPhases

名称	必选	允许NULL	类型	描述
Name	否	是	String	名字示例值：
Type	否	是	Int64	类型示例值：
Status	否	是	String	状态示例值：
ErrorMessage	否	是	String	错误信息示例值：

ConfigDownloadResult

配置下载结果

被如下接口引用：DownloadConfig

名称	必选	允许NULL	类型	描述
Result	是	是	String	base64 示例值：
FileName	是	是	String	下载的配置文件名称示例值：

ContainGroup

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

被如下接口引用：DescribeContainerGroups、ListContainGroup

名称	必选	允许NULL	类型	描述
CreateTime	否	是	String	创建时间示例值： 2026-03-19 11:57:10
CpuRequest	是	是	String	初始分配的 CPU 核数，对应 K8S request 示例值： 0.2
CpuLimit	是	是	String	最大分配的 CPU 核数，对应 K8S limit 示例值： 0.4
GroupName	否	是	String	分组名称示例值： group-test-name
TagName	是	是	String	镜像版本名称示例值： v1
NamespaceId	是	是	String	命名空间ID 示例值： namespace-xxxx123
MemLimit	是	是	String	最大分配的内存 MiB 数，对应 K8S limit 示例值： 300
Server	是	是	String	镜像server 示例值： xxx.image.com
RepoName	是	是	String	镜像名，如/tsf/nginx 示例值： /tsf/nginx
ClusterId	是	是	String	集群ID 示例值： cluster-xxx123
ClusterName	是	是	String	集群名称示例值： cls-name
NamespaceName	是	是	String	命名空间名称示例值： ns-name
UpdatedTime	否	是	String	更新时间示例值： 2026-03-19 11:57:10
GroupId	否	是	String	部署组ID 示例值： group-12xxxxxx
MemRequest	是	是	String	初始分配的内存 MiB 数，对应 K8S request 示例值： 100
Alias	是	是	String	部署组备注示例值：部署组备注
KubeInjectEnable	是	是	Bool	KubeInjectEnable值示例值： true
UnitId	否	是	String	单元ID 示例值： unit-id
UnitName	否	是	String	单元名称示例值： unit-name
EnabledUnit	否	是	Bool	是否开启单元化示例值： false
K8sNamespaceName	否	是	String	k8s命名空间名称示例值： k8s-ns-name

DescribeContainerTasksResult

被如下接口引用：DescribeContainerTasks

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

CustomPodSchedule

自定义Pod调度规则

被如下接口引用：DeployContainerApplication、DeployContainerGroup、DescribeContainerGroupDeployInfo

名称	必选	允许NULL	类型	描述
ForceSchedule	否	否	ForceSchedule	- 示例值：查看
TrySchedule	否	否	TrySchedule	- 示例值：查看

RatelimitRuleForUpdateV2

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

被如下接口引用：UpdateRatelimit

名称	必选	允许NULL	类型	描述
Id	是	是	String	规则ID 示例值：
Status	否	是	Uint64	状态 0表示启用 1表示停用示例值：
DurationSecond	否	是	Uint64	限流周期，单位秒示例值：
LimitedResponse	否	是	String	限流自定义返回文本示例值：
ConditionModel	否	是	String	限流阈值类型示例值：
Name	否	是	String	规则名字，在一个微服务下唯一示例值：
DurationQuota	否	是	Uint64	每周期内的限流配额示例值：
Description	否	是	String	描述示例值：
Dimensions	否	是	Array of RatelimitDimension	标签规则示例值：查看
ConcurrentThreads	否	是	String	线程数示例值：
LimitMode	否	是	String	限流模式示例值：
SourceService	否	是	String	源服务示例值：

ReleaseGroup

发布单部署组

被如下接口引用：DescribeReleaseTemplate、ModifyReleaseTemplate

名称	必选	允许NULL	类型	描述
GroupId	是	否	String	部署组ID 示例值：
GroupName	否	是	String	部署组名示例值：

DeployContainerApplicationResp

部署后返回的结构体

被如下接口引用：DeployContainerApplication

名称	必选	允许NULL	类型	描述
GroupId	否	是	String	部署组ID 示例值：
TaskId	否	是	String	任务ID 示例值：

InstanceEnrichedInfo

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

被如下接口引用：DescribeInstances

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

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	任务已执行时长, 单位:秒示例值：
Attr	否	是	ApmTaskAttr	任务扩展字段示例值：查看

ResourcePool

虚机弹性伸缩资源池对象

被如下接口引用：DescribeResourcePools

名称	必选	允许NULL	类型	描述
ClusterId	是	是	String	资源池所属集群示例值：
TotalInstanceCount	是	是	Int64	资源池伸缩组总实例数示例值：
AvailableInstanceCount	是	是	Int64	资源池伸缩组可用实例数示例值：
MaxNodesNum	是	是	Int64	资源池伸缩组最大实例数示例值：
InstanceImportMode	是	是	String	实例导入tsf集群类型示例值：
ResourcePoolId	是	是	String	资源池 ID 示例值：
VpcId	是	是	String	伸缩组伸缩组VPC 示例值：
MinNodesNum	是	是	Int64	资源池伸缩组最小实例数示例值：
AutoScalingGroupName	是	是	String	资源池对应弹性伸缩组名称示例值：
LaunchConfigurationId	是	是	String	伸缩组启动配置 ID 示例值：
SubnetIds	是	是	Array of String	伸缩组伸缩组子网列表示例值：
EnabledStatus	是	是	String	资源池启用状态示例值：
AutoScalingGroupId	是	是	String	资源池对应弹性伸缩组 ID 示例值：
LaunchConfigurationName	是	是	String	伸缩组启动配置名称示例值：
Name	是	是	String	资源池名称示例值：

StorageClass

存储类型

被如下接口引用：ListStorageClasses

名称	必选	允许NULL	类型	描述
DiskType	否	否	String	云盘类型示例值：
Name	否	否	String	名称示例值：
Provisioner	否	否	String	提供厂商示例值：
ReclaimPolicy	否	否	String	删除保留策略【枚举值：Recycle、Delete、Retain】示例值：
VolumeBindingMode	否	否	String	绑定模式【枚举值：Immediate、WaitForFirstConsumer】示例值：
AccessModes	否	否	Array of String	读写模式【枚举值：ReadWriteOnce、ReadOnlyMany、ReadWriteMany】示例值：

VmGroupSimple

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

被如下接口引用：DescribeGroups

名称	必选	允许NULL	类型	描述
NamespaceId	是	是	String	命名空间ID 示例值： namespace-6a79x94v
UpdatedTime	是	是	Int64	部署组更新时间戳示例值： 17898792000
JdkName	否	是	String	无示例值： JDK
OtAgentVersion	否	是	String	无示例值： latest
UpdateTime	是	是	String	部署组更新时间示例值： 176230473
StartScript	否	是	String	无示例值： echo start
Status	否	是	String	无示例值： running
ServiceAgentVersion	否	是	String	无示例值： latest
UpdateType	否	是	Int64	无示例值： 1
GroupDesc	是	是	String	部署组描述示例值： this is a desc
ClusterName	是	是	String	集群名称示例值： k8s-cls
DeployDesc	是	是	String	部署应用描述信息示例值： this is a desc
AgentProfileList	否	是	Array of AgentProfile	无示例值：查看
WarmupSetting	否	是	WarmupSetting	无示例值：查看
StopScript	否	是	String	无示例值： echo stop
GroupId	是	是	String	部署组ID 示例值： group-6a79x94v
ApplicationType	是	是	String	应用类型示例值： C
ClusterId	是	是	String	集群ID 示例值： cls-6a79x94v
StartupParameters	是	是	String	部署组启动参数示例值： -Xms256m -Xmx512m
CreateTime	是	是	String	部署组创建时间示例值： 2020-12-23 12:34:56
ApplicationId	是	是	String	应用ID 示例值： application-6a79x94v
Alias	是	是	String	部署组备注示例值：备注
ForceStart	否	是	Bool	无示例值： false
NamespaceName	是	是	String	命名空间名称示例值： default
MicroserviceType	是	是	String	应用微服务类型示例值： DEF
ApplicationName	是	是	String	应用名称示例值： app-demo
GroupResourceType	是	是	String	部署组资源类型示例值： C
GroupName	是	是	String	部署组名称示例值： foo
JdkVersion	否	是	String	无示例值： 8
GatewayConfig	否	是	GatewayConfig	无示例值：查看
ServiceSpecEncode	否	是	String	无示例值： spec-xxxxxxxxxx
UnitType	否	是	String	单元类型示例值： Global
UnitEnvType	否	是	String	单元环境类型示例值： Prod
K8sNamespaceName	否	是	String	k8s命名空间名称示例值： namespace-xx
Tags	否	是	Array of Tag	标签列表示例值：查看
UnitName	否	是	String	单元名称示例值： unit-xxx
BusinessSystemId	否	是	String	业务系统id 示例值： busi-xxx
BusinessSystemName	否	是	String	业务系统name 示例值：业务x
DeployExeMode	否	是	String	部署方式示例值： batch
ExclusiveInstances	否	是	Array of ExclusiveInstance	独占实例示例值：查看
DeployBatch	否	是	Array of Float	批量部署比例示例值： [0.1,0.9]
FilebeatCgroupEnable	否	是	Bool	是否开启filebeat cgroup 示例值： true
TapmOtAgentVersion	否	是	String	ot agent版本示例值： release
EnableTelemetry	否	是	Bool	是否开启ot 示例值： true
BusinessLogConfigIdList	否	是	String	业务日志配置项id list 示例值： [busi-xx,busi-aa]
DeployBetaEnable	否	是	Bool	是否开启beta批量部署示例值： true
FrameworkType	否	是	String	开发框架示例值： spring
MicroserviceSubType	否	是	String	微服务子类型示例值： xx
FilebeatMaxCpu	否	是	Float	filebeat max cpu 示例值： 0.5
NonInvasiveType	否	是	String	无侵入类型示例值： xxx
FilebeatMaxMem	否	是	Float	filebeat max mem 示例值： 500
EnabledUnit	否	是	Bool	是否开启单元化示例值： true
UnitId	否	是	String	单元id 示例值： unit-xx
EnableTelemetryAgent	否	是	Bool	是否开启ot 示例值： true
Language	否	是	String	语言示例值： zh-cn
BusinessLogDeliveryConfigIdList	否	是	String	日志投递项id list 示例值： [delivery-xx,deliver-aa]
HealthCheckSettings	否	是	HealthCheckSettings	健康检查配置示例值：查看
ClsMachineGroupId	否	是	String	cls id 示例值： cls-xx
InstanceIdList	否	是	Array of String	instance id list 示例值： [ins-xx,ins-aa]
EnableBatchHealthCheck	否	是	Bool	是否开启分批健康检查示例值： true
GovernanceType	否	是	String	注册类型示例值： exclusive
DeployWaitTime	否	是	Uint64	分批部署等待时间示例值： 10
RealNamespaceName	否	是	String	实际命名空间name 示例值： xxx
EnableGovernance	否	是	Bool	是否使用服务注册示例值： true
ServiceConfigList	否	是	Array of ServiceConfig	mesh service spec 示例值：查看

BillingLicense

计费许可

被如下接口引用：DescribeAllBillingLicenses

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

ApiRateLimitRule

微服务网关API限流规则

被如下接口引用：CreateApiRateLimitRuleWithDetailResp、DescribeApiRateLimitRules

名称	必选	允许NULL	类型	描述
RuleId	是	是	String	rule Id 示例值：
MaxQps	是	是	Uint64	最大限流qps 示例值：
UsableStatus	是	是	String	生效/禁用, enabled/disabled 示例值：
TsfRuleId	是	是	String	Tsf Rule ID 示例值：
Description	是	是	String	描述示例值：
CreatedTime	是	是	String	创建时间示例值：
UpdatedTime	是	是	String	更新时间示例值：
Limit	否	是	Int64	分页参数limit 示例值：
ApiId	是	是	String	API ID 示例值：
RuleName	是	是	String	限流名称示例值：
RuleContent	是	是	String	规则内容示例值：
Offset	否	是	Int64	分页参数offset 示例值：
AppId	否	是	String	AppId 示例值：

InvocationStatistics

调用统计数据

被如下接口引用：GetInvocationStatistics

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

TaskInstance

被如下接口引用：ListScalableTasks

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

TemplateProject

ProjectList

被如下接口引用：DescribeTemplates

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

MachineList

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

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

ScalableTask

被如下接口引用：ListScalableTasks

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

PagedDtsBranch

DTS分支事务分页对象

被如下接口引用：DescribeDtsBranches

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

RouteV2

路由规则信息

被如下接口引用：DescribeRoute、DescribeRoutes

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

ImageTagsResult

镜像版本列表

被如下接口引用：DescribeImageTags、ImageGetTagList

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

TsfZone

TSF可用区信息

被如下接口引用：DescribeTsfZones

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

SchedulingStrategy

tsf 容器集群节点调度策略

被如下接口引用：DeployContainerApplication、DeployContainerGroup、DescribeContainerGroupDeployInfo

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

GroupPod

部署组实例列表

被如下接口引用：DescribePodInstances

名称	必选	允许NULL	类型	描述
NodeInstanceId	是	是	String	节点实例id 示例值： ins-6a79x94v
Status	是	是	String	实例状态，请参考后面的实例以及容器的状态定义。启动中（pod 未 ready）：Starting；运行中：Running；异常：Abnormal；停止：Stopped；示例值： Running
Ip	是	是	String	实例IP 示例值： 10.10.0.2
InstanceAvailableStatus	是	是	String	机器实例可使用状态，枚举值为Starting/Running/Stopping/Stopped/StopFailed/Abnormal/Unknown 示例值： Running
InstanceStatus	是	是	String	机器实例状态示例值： Running
PodName	是	是	String	实例名称(对应到kubernetes的pod名称) 示例值： app-2bs821-sb782ns
NodeIp	是	是	String	主机IP 示例值： 10.10.0.1
ReadyCount	是	是	Int64	实例中已就绪容器的个数示例值： 1
CreatedAt	是	是	String	实例启动时的时间戳示例值： 158702289
ServiceInstanceStatus	是	是	String	服务实例状态，枚举值为Starting/Running/Stopping/Stopped/StopFailed/Abnormal/Unknown 示例值： Abnormal
SpecTotalCount	否	否	String	预期副本数示例值： 1
PodId	是	是	String	实例ID(对应到kubernetes的pod id) 示例值： pod-id
Reason	是	是	String	实例处于当前状态的原因，例如容器下载镜像失败示例值： failed
Containers	否	是	Array of PodContainer	Containers 示例值：查看
RestartCount	是	是	Int64	实例中容器的重启次数示例值： 1
Runtime	是	是	String	运行时长，单位秒示例值： 10
TaskStatus	否	是	String	任务状态示例值： success
TaskId	否	是	String	任务ID 示例值： task-123xxx
NodeIpv6	否	是	String	主机IPv6 示例值： FC00:0:1:5002::101
Ipv6	否	是	String	实例IPv6 示例值： FC00:0:1:5002::101

GatewayPluginBoundParam

微服务网关插件绑定对象

被如下接口引用：BindPlugin、UnbindPlugin

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

TsfPageContainerEvent

分页的 ContainerEvent

被如下接口引用：DescribeContainerEvents

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Int64	返回个数示例值：
Content	是	否	Array of ContainerEvent	events 数组示例值：查看

ApiDailyUseStatisticsEntity

被如下接口引用：DescribeUnitApiUseDetail

名称	必选	允许NULL	类型	描述
Name	是	是	String	Name 示例值：
Count	是	是	String	Count 示例值：
Ratio	是	是	String	Ratio 示例值：

PagedProgram

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

被如下接口引用：DescribePrograms

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

TaskId

任务id

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

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

ContainerTasksResult

变更记录任务列表

被如下接口引用：ListContainerTask

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

UploadInfo

上传包ID

被如下接口引用：UploadPkg

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

MonitorStatisticsPolicyResult

被如下接口引用：ListMonitorStatisticsPolicy

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	TotalCount 示例值： 10
Content	是	是	Array of MonitorStatisticsPolicy	Content 示例值：查看

ReleasePipelineRun

发布单流水线执行详情

被如下接口引用：DescribeReleasePipelineRun

名称	必选	允许NULL	类型	描述
TriggerType	否	是	String	触发类型示例值：
Status	否	是	String	执行状态示例值：
StartTime	否	是	Int64	开始时间示例值：
EndTime	否	是	Int64	结束时间示例值：
Uin	否	是	String	主帐号示例值：
SubAccountUin	否	是	String	子帐号示例值：
Nickname	否	是	String	昵称示例值：
Stages	否	是	Array of ReleaseStage	DAG信息示例值：查看
ReleaseType	否	是	String	发布单类型示例值：
TemplateType	否	是	String	模板类型示例值：
TaskCount	否	是	Uint64	任务节点数示例值：

ApmTaskAttr

APM 下发任务扩展参数

被如下接口引用：DescribeApmTaskStatus

名称	必选	允许NULL	类型	描述
Data	否	是	String	扩展数据示例值：
Status	否	是	String	状态示例值：
StatusInfo	否	是	String	状态信息示例值：

EventDataPointResult

事件趋势曲线点

被如下接口引用：DescribeEventTrend

名称	必选	允许NULL	类型	描述
Key	是	否	String	时间戳示例值：
Value	是	否	String	值示例值：

ApiInfo

微服务网关API信息

被如下接口引用：CreateGatewayApi

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

TaskRule

任务规则

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

名称	必选	允许NULL	类型	描述
RuleType	是	否	String	触发规则类型，枚举值。一共3个值，Cron：定时触发，Repeat：周期触发，WorkFlow：工作流触发示例值：
Expression	否	是	String	Cron类型规则，cron表达式。示例值：
RepeatInterval	否	是	Uint64	时间间隔，单位毫秒示例值：

ClsConfigFilter

被如下接口引用：DescribeClsConfig、DescribeClsLogsets、DescribeClsTopics

名称	必选	允许NULL	类型	描述
Key	否	是	String	s 示例值：
Values	否	是	Array of String	d 示例值：

TsfPageFileConfigReleaseLog

文件配置项发布日志列表

被如下接口引用：DescribeFileConfigReleaseLogs

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Int64	数量示例值：
Content	是	是	Array of FileConfigReleaseLog	列表示例值：查看

ServiceStatisticsV2

服务运行统计指标

被如下接口引用：DescribeServiceStatistics、GetMicroServiceStatistics

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

TsfPrice

Tsf 询价返回

被如下接口引用：DescribePrice

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

InstanceMetrics

实例监控指标

被如下接口引用：DescribeInstanceMetrics

名称	必选	允许NULL	类型	描述
Connection	是	否	MetricAttribute	连接数示例值：查看
InstanceId	是	否	String	节点Id 示例值：
CpuUsed	是	否	MetricAttribute	CPU使用量（单位为核）示例值：查看
CpuCores	是	否	MetricAttribute	CPU核数示例值：查看
ActiveThreads	是	否	MetricAttribute	活动线程数示例值：查看
InboundTraffic	是	否	MetricAttribute	入流量（单位为MB) 示例值：查看
Network	是	否	MetricAttribute	网络I/O（单位为KB/S）示例值：查看
DaemonThreads	是	否	MetricAttribute	守护线程数示例值：查看
InstanceName	是	否	String	节点名称示例值：
CpuUsage	是	否	MetricAttribute	CPU利用率（%）示例值：查看
MemoryUsed	是	否	MetricAttribute	内存使用量示例值：查看
MemoryUsage	是	否	MetricAttribute	内存利用率（%）示例值：查看
NioThreads	是	否	MetricAttribute	NIO线程数示例值：查看
TotalThreads	是	否	MetricAttribute	总线程数示例值：查看

AuthRuleGroup

微服务权限规则组

被如下接口引用：DescribeAuthorizationType

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

TsfPageAuthRule

TSF标准分页的AuthRule列表

被如下接口引用：DescribeAuthorizations

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

MicroserviceSummary

服务治理概要

被如下接口引用：DescribeMicroServiceSummaryList

名称	必选	允许NULL	类型	描述
Type	是	是	String	Type值示例值：
UpdateTime	是	是	Int64	UpdateTime值示例值：
Id	是	是	String	Id值示例值：
Name	是	是	String	Name值示例值：

ClusterLimitResourceV2

集群limit资源

被如下接口引用：DescribeClusterLimitResource

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

DeploymentUnit

单元系统

被如下接口引用：DescribeUnitsByBusinessSystemIds

名称	必选	允许NULL	类型	描述
BusinessSystemId	否	否	String	业务系统 id 示例值：
Units	否	否	Array of DU	单元系统示例值：查看

TsfPageStdoutLogV2

标准输出日志列表

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

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

MetricAttribute

监控指标信息

被如下接口引用：DescribeInstanceMetrics

名称	必选	允许NULL	类型	描述
PeakValue	是	否	String	峰值示例值：
CurrentValue	是	否	String	当前值示例值：

ApplicationServerLogContent

日志内容

被如下接口引用：DescribeApplicatoinServerLog

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

GatewayTagPlugin

微服务网关TAG插件明细

被如下接口引用：DescribeGatewayTagPlugin

名称	必选	允许NULL	类型	描述
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串示例值：
Id	是	否	String	网关插件id 示例值：

InstanceReleasedConfig

实例发布配置

被如下接口引用：DescribeInstanceReleasedConfig

名称	必选	允许NULL	类型	描述
MemoryConfig	是	是	String	实例内存生效配置（相关key限定在tsf下发配置范围内）示例值： memory: value_in_me
ReleaseConfig	是	是	String	查询发布的配置，包括应用配置和全局配置示例值： param_key: value

ExpandSubrule

被如下接口引用：DescribeScalableRuleAttribute

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

ApiDefinitionDescr

API 对象类型描述

被如下接口引用：DescribeApiDetail

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

PagedResource

分页资源列表

被如下接口引用：DescribeResources

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

CommonKvDetail

主要用于 secret、pvc、configMaps

被如下接口引用：DescribeConfigMaps、DescribeSecrets

名称	必选	允许NULL	类型	描述
Name	否	是	String	名称示例值：
Keys	否	是	Array of String	值示例值：

DailyUseStatisticsEntity

日统计数据节点

被如下接口引用：DescribeGatewayDailyUseStatistics

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

TsfPageInstanceMetrics

分页实例监控指标信息

被如下接口引用：DescribeInstanceMetrics

名称	必选	允许NULL	类型	描述
TotalCount	是	否	Uint64	记录总数示例值：
Content	是	否	Array of InstanceMetrics	记录实体列表示例值：查看

CircuitBreakerApi

熔断API规则

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

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

Program

tsf-privilege模块 Program数据集

被如下接口引用：DescribeGatewayInstancePrograms、DescribeProgram、DescribePrograms

名称	必选	允许NULL	类型	描述
ProgramId	否	是	String	数据集ID 示例值：
ProgramName	否	是	String	数据集名称示例值：
ProgramDesc	否	是	String	数据集描述示例值：
DeleteFlag	否	是	Bool	删除标识，true: 可以删除; false: 不可删除示例值：
CreationTime	否	是	Int64	创建时间示例值：
LastUpdateTime	否	是	Int64	最后更新时间示例值：
ProgramItemList	否	是	Array of ProgramItem	数据项列表，无值时返回空数组示例值：查看
SubAccountUin	否	是	String	用户唯一ID 示例值：
ResourceCode	否	是	String	资源编码示例值：
ServiceCode	否	是	String	服务编码示例值：
ProgramItemIsAll	否	是	Bool	ProgramItem的isAll字段，全选标识示例值：
Uin	否	是	String	用户唯一ID 示例值：
AppId	否	是	String	App ID 示例值：

Resource

tsf-privilege 模块，资源

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

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

GatewayPluginModel

被如下接口引用：DescribeGatewayWithPlugin

名称	必选	允许NULL	类型	描述
GatewayInstanceId	否	是	String	网关实例id 示例值：
ServiceName	否	是	String	服务名示例值：
ServiceId	否	是	String	服务id 示例值：
PluginId	否	是	String	插件id 示例值：

HttpGetOption

HttpGet 执行内容

被如下接口引用：DeployContainerApplication、DeployContainerGroup、DescribeContainerGroupDeployInfo

名称	必选	允许NULL	类型	描述
Host	否	是	String	主机地址示例值：
Path	否	是	String	路径示例值：
Port	否	是	String	端口示例值：
Scheme	否	是	String	协议：HTTP｜HTTPS 示例值：

MicroServiceMetas

服务元数据

被如下接口引用：DescribeMicroserviceMetas

名称	必选	允许NULL	类型	描述
Type	否	是	String	服务类型示例值： dubbo3
Key	否	是	String	元数据key 示例值： key_demo1
Value	否	是	String	元数据value 示例值： val_demo1
Keys	否	是	Array of String	元数据 keys，入参时使用示例值： ["k1","k2"]

GatewayPluginId

微服务网关插件Id

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

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

TraceSpanInfo

span查询的出参

被如下接口引用：SearchSpan

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

SetUpKubeInjectResult

SetUpKubeInjectResult值

被如下接口引用：SetUpKubeInject

名称	必选	允许NULL	类型	描述
Success	是	是	Bool	success值示例值：
Yaml	否	是	String	当参数 ReturnYaml 为 true 时，返回的 yaml 示例值：

TaskGroupPage

任务分组翻页查询结果

被如下接口引用：DescribeTaskGroups

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

ServiceStatistics

服务运行统计指标

被如下接口引用：GetServiceStatistics

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

InvocationMetricScatterPlot

监控数据散点图

被如下接口引用：DescribeInvocationMetricScatterPlot

名称	必选	允许NULL	类型	描述
EndTime	是	否	Int64	时间轴截止时间，GMT，精确到毫秒示例值：
StartTime	是	否	Int64	时间粒度示例值：
Period	是	否	Int64	时间轴开始时间，GMT，精确到毫秒示例值：
DataPoints	是	是	Array of MultiValueDataPoints	多值数据点集合示例值：查看

KafkaDeliveryConfig

投递kafka配置项

被如下接口引用：DescribeDeliveryConfig

名称	必选	允许NULL	类型	描述
KafkaVIp	是	是	String	kafka vip 示例值：
KafkaVPort	是	是	String	kafka vport 示例值：
Topic	是	是	String	kafka topic 示例值：
LineRule	是	是	String	换行规则示例值：
Username	是	是	String	用户名示例值：
Password	是	是	String	密码示例值：
EnableGlobalLineRule	是	是	Bool	是否应用单行规则示例值：
KafkaAddress	否	是	String	KafkaAddress 示例值：
ConfigId	是	是	String	配置项id 示例值：
ConfigName	是	是	String	配置名称示例值：
CollectPath	是	是	Array of String	采集路径示例值：
EnableAuth	是	是	Bool	是否需要认证示例值：
KafkaInfos	是	是	Array of DeliveryKafkaInfo	投递的topic和path 示例值：查看
CustomRule	是	是	String	自定义分行规则示例值：

TsfPageBillingOperationRecord

BillingOperationRecord 翻页对象

被如下接口引用：DescribeBillingOperationRecords

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

HealthCheckSetting

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

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

ScalableSubRule

弹性扩缩容监控指标类型

被如下接口引用：CreateScalableRule、CreateScalableRuleWithDetailResp、ModifyScalableRule

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

TsfPageApiGroupInfo

ApiGroupInfo翻页结构体

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

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

GatewayVo

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

被如下接口引用：DescribeGatewayAllGroupApis

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

TsfRecordCodeResult

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

被如下接口引用：DescribeRecordCodes

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

PagedDtsGroup

事务分组分页对象

被如下接口引用：DescribeDtsGroups

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

RatelimitListResult

none

被如下接口引用：DescribeRatelimit

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

CheckTseConnect

校验北极星实例接口返回体

被如下接口引用：CheckTseConnect

名称	必选	允许NULL	类型	描述
VpcId	否	是	String	vpc id 示例值：
VpcName	否	是	String	vpc name 示例值：
Success	否	是	Bool	是否连通校验成功示例值：

VisitAccount

体验账号

被如下接口引用：DescribeVisitAccount

名称	必选	允许NULL	类型	描述
ExpireTime	是	是	String	无示例值：
Full	是	是	Bool	是否满人示例值：
VisitAppId	否	是	String	无示例值：
VisitName	是	是	String	无示例值：
VisitSubAccountUin	是	是	String	无示例值：
VisitPassword	是	是	String	无示例值：
Visit	是	是	Bool	当前是否体验账号示例值：
VisitUin	否	是	String	无示例值：
CreateTime	是	是	String	无示例值：

ProtocolPort

端口对象

被如下接口引用：CreateContainGroup、CreateContainerService、DeployContainerApplication、DeployContainerGroup、DescribeContainerGroupAttribute、DescribeContainerGroupDeployInfo、DescribeContainerGroupDetail、DescribeSingleContainerGroups、FindContainerGroup、GetContainGroupDeployInfo、ModifyContainerGroup、ModifyContainerService、UpdateContainerGroup

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

ContainerGroupServiceGovernanceConfig

服务治理相关配置项

被如下接口引用：DeployContainerApplication、DescribeContainerGroupDeployInfo、DescribeSimpleApplications、OperateKubeInject

名称	必选	允许NULL	类型	描述
EnableGovernance	否	是	Bool	是否开启服务治理示例值： true
ServiceConfigList	否	是	Array of ServiceConfig	控制台场景使用 mesh服务配置信息列表示例值：查看
ExclusiveInstances	否	是	Array of ExclusiveInstance	注册服务治理实例示例值：查看
GovernanceType	否	是	String	服务治理类型示例值： SHARE
NamespaceId	否	是	String	命名空间ID 示例值： namespace-6yornxxx

ClsLogConfig

cls 日志配置项信息

被如下接口引用：DescribeClsConfig

名称	必选	允许NULL	类型	描述
ConfigId	否	是	String	日志配置项主键示例值：
Uin	否	是	String	uin 示例值：
Region	否	是	String	地域示例值：
Description	否	是	String	备注示例值：
LogsetId	否	是	String	日志集id 示例值：
CamContext	否	是	String	CamContext 示例值：
AppId	否	是	String	appid 示例值：
Paths	否	是	Array of String	日志采集路径示例值：
ClsSdkConfig	否	是	String	提取模式json串示例值：
UpdateTime	否	是	String	更新时间示例值：
AssociatedGroups	否	是	Array of BusinesLogConfigAssociatedGroup	关联部署组示例值：查看
LogsetName	否	是	String	日志集名称示例值：
Action	否	是	String	操作指令示例值：
Name	否	是	String	日志配置项名称示例值：
SubAccountUin	否	是	String	subAccountUin 示例值：
TopicId	否	是	String	日志主题id 示例值：
ProgramIdList	否	是	Array of String	数据集id列表示例值：
CreateTime	否	是	String	创建时间示例值：
Status	否	是	Int64	是否删除的状态标志示例值：
TopicName	否	是	String	日志主题名称示例值：

InstanceEnrichedInfoPage

InstanceEnrichedInfo列表结构

被如下接口引用：DescribeInstances

名称	必选	允许NULL	类型	描述
TotalCount	是	是	Uint64	总数量示例值：
Content	是	是	Array of InstanceEnrichedInfo	列表示例值：查看

IpListResult

被如下接口引用：CreateServiceInstance

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

MicroserviceCount

服务数量信息

被如下接口引用：DescribeNamespaceMicroserviceCount

名称	必选	允许NULL	类型	描述
NormalVarianceCount	是	否	Int64	在线服务数变化量示例值：
AbnormalCount	是	否	Int64	异常服务数示例值：
AbnormalVarianceCount	是	否	Int64	异常服务数变化量示例值：
MsCount	是	否	Int64	总服务数示例值：
MsVarianceCount	是	否	Int64	总服务变化量示例值：
NormalCount	是	否	Int64	在线服务数示例值：

BatchTemplate

分批分布模板

被如下接口引用：DescribeReleaseTemplate、ModifyReleaseTemplate

名称	必选	允许NULL	类型	描述
ApplicationId	是	否	String	应用ID 示例值： application-m2vzz3vp
ApplicationType	是	否	String	应用类型示例值： consumer-demo
PackageId	否	是	String	程序包ID 示例值：
EnableFileConfig	否	是	Bool	是否允许文件配置示例值： false
RepoType	否	是	String	镜像仓库类型示例值：
RepositoryType	否	是	String	仓库类型示例值：
RepoName	否	是	String	镜像仓库名示例值：
TagName	否	是	String	镜像版本示例值：
EnableApplicationConfig	否	是	Bool	是否允许应用配置示例值：
PriorApplicationConfig	否	是	Bool	是否先进行应用配置发布，再部署程序示例值：
FileConfigs	否	是	Array of FileConfig	文件配置列表示例值：查看
PackageVersion	否	是	String	包版本示例值：
RepositoryId	否	是	String	仓库id 示例值：
RepositoryName	否	是	String	仓库名称示例值：
BatchGroups	是	是	Array of BatchGroup	分批部署组列表示例值：查看
ApplicationName	是	是	String	应用名示例值：
ApplicationConfigs	否	是	Array of ApplicationConfig	应用配置列表示例值：查看
PackageName	否	是	String	包名示例值：
GrayBatchGroups	否	是	Array of BatchGroup	灰度分批部署组列表示例值：查看

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 示例值：