数据结构

最近更新时间: 2026-07-12 00:20:55

MicroserviceExtra

微服务(信息更丰富版)

被如下接口引用:DescribeMicroservicesByAssociateApplication

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

RealtimeLogSet

实时日志查询结果集合

被如下接口引用:SearchRealtimeBusinessLog、SearchRealtimeStdoutLog

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

TsfPageImageFeature

镜像特征列表

被如下接口引用:DescribeImageFeatures

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

MemoryPicture

Jvm监控内存数据封装

被如下接口引用:DescribeJvmMonitor

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

ApiDefinitionDescr

API 对象类型描述

被如下接口引用:DescribeApiDetail

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

GatewayGroupApiVo

网关API简单信息

被如下接口引用:DescribeGatewayAllGroupApis

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

SecretKeyInfo

微服务网关密钥信息

被如下接口引用:ChangeSecretStatus、DescribeGroupSecrets

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

ApiVersionArray

API版本数组

被如下接口引用:DescribeApiVersions

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

TsfPageTraceSpanInfo

分页spaninfo的结构

被如下接口引用:SearchSpan

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

PackageConfig

程序包相关配置信息

被如下接口引用:DescribeResourceConfig

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

GroupUnitInfo

部署组单元信息

被如下接口引用:DescribeGroupUnitInfo

名称 必选 允许NULL 类型 描述
EnabledUnit Bool 是否开启单元化
示例值:
UnitId String 单元 id
示例值:
UnitName String 单元名称
示例值:
BusinessSystemId String 业务系统 id
示例值:
BusinessSystemName String 业务系统名称
示例值:

InstanceEnrichedInfo

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

被如下接口引用:DescribeInstances

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

RouteDestItemV2

服务路由目标匹配项

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

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

ServiceStatisticsV2

服务运行统计指标

被如下接口引用:DescribeServiceStatistics

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

TaskRule

任务规则

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

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

SidecarFilters

分页展示过滤器

被如下接口引用:DescribeSidecarFilters

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

GatewayApiGroupVo

网关分组简单信息

被如下接口引用:DescribeGatewayAllGroupApis

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

VmGroupSimple

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

被如下接口引用:DescribeGroups

名称 必选 允许NULL 类型 描述
GroupId String 部署组ID
示例值:
GroupName String 部署组名称
示例值:
ApplicationType String 应用类型
示例值:
GroupDesc String 部署组描述
示例值:
UpdateTime String 部署组更新时间
示例值:
ClusterId String 集群ID
示例值:
StartupParameters String 部署组启动参数
示例值:
NamespaceId String 命名空间ID
示例值:
CreateTime String 部署组创建时间
示例值:
ClusterName String 集群名称
示例值:
ApplicationId String 应用ID
示例值:
ApplicationName String 应用名称
示例值:
NamespaceName String 命名空间名称
示例值:
MicroserviceType String 应用微服务类型
示例值:
GroupResourceType String 部署组资源类型
示例值:
UpdatedTime Int64 部署组更新时间戳
示例值:
DeployDesc String 部署应用描述信息
示例值:
Alias String 部署组备注
示例值:
JdkName String
示例值:
JdkVersion String
示例值:
ServiceAgentVersion String
示例值:
StartScript String
示例值:
AgentProfileList Array of AgentProfile
示例值:查看
GatewayConfig GatewayConfig
示例值:查看
Status String
示例值:
WarmupSetting WarmupSetting
示例值:查看
ForceStart Bool
示例值:
UpdateType Int64
示例值:
ServiceSpecEncode String
示例值:
StopScript String
示例值:
OtAgentVersion String
示例值:
UnitType String 单元类型
示例值:
UnitEnvType String 单元环境类型
示例值:

TsfPageConfigReleaseLog

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

被如下接口引用:DescribeConfigReleaseLogs、DescribePublicConfigReleaseLogs

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

TsfPageGatewayInstance

网关实体分页信息

被如下接口引用:DescribeGatewayInstances、DescribeGatewayInstancesByMultiCloud

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

MetricAttribute

监控指标信息

被如下接口引用:DescribeInstanceMetrics

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

ContainerTasks

变更记录任务

被如下接口引用:DescribeContainerTasks、ListContainerTask

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

StorageClass

存储类型

被如下接口引用:ListStorageClasses

名称 必选 允许NULL 类型 描述
Name String 名称
示例值:
Provisioner String 提供厂商
示例值:
ReclaimPolicy String 删除保留策略
示例值:
VolumeBindingMode String 绑定模式
示例值:
AccessModes Array of String 读写模式
示例值:
DiskType String 云盘类型
示例值:

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
示例值:

ImageUserIsExists

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

被如下接口引用:DescribeImageUserIsExists

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

MonitorOverview

监控概览对象

被如下接口引用:DescribeGatewayMonitorOverview

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

TaskGroupPage

任务分组翻页查询结果

被如下接口引用:DescribeTaskGroups

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

GatewayWeChatMiniProgramLoginPlugin

微服务网关微信登录插件

被如下接口引用:DescribeGatewayWeChatMiniProgramLoginPlugin

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

ThreadDumpData

DescribeThreadDetail 接口出参封装

被如下接口引用:DescribeThreadDump

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

ImageInfo

镜像信息

被如下接口引用:DescribeImages

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

TsfPageResourcePoolInstance

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

被如下接口引用:DescribeResourcePoolInstances

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

OverviewLicenseResourceUsage

license相关信息概览

被如下接口引用:DescribeLicenseInfo

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

HealthCheckSettings

健康检查参数

被如下接口引用:DeployContainerGroup、DeployGroup、DescribeContainerGroupDeployInfo、DescribeContainerGroupDetail、DescribeGroup、DescribeGroupAttribute、DescribeGroupOther、UpdateHealthCheckSettings

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

BusinessLogV2

业务日志

被如下接口引用:SearchBusinessLog、SearchRealtimeBusinessLog、SearchRealtimeStdoutLog、SearchSpanBusinessLog、SearchSurroundBusinessLog

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

InstanceResourceConfig

实例相关的参数配置

被如下接口引用:DescribeResourceConfig

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

ServiceSetting

容器网络设置。

被如下接口引用:DeployContainerGroup

名称 必选 允许NULL 类型 描述
AccessType Int64 0:公网, 1:集群内访问, 2:NodePort, 3: VPC 内网访问
示例值:
ProtocolPorts Array of ProtocolPort 容器端口映射
示例值:查看
SubnetId String 子网ID
示例值:
DisableService Bool 是否创建 k8s service,默认为 false
示例值:
HeadlessService Bool service 是否为 headless 类型
示例值:
AllowDeleteService Bool 当为 true 且 DisableService 也为 true 时,会删除之前创建的 service,请小心使用
示例值:
OpenSessionAffinity Bool 开启SessionAffinity,true为开启,false为不开启,默认为false
示例值:
SessionAffinityTimeoutSeconds Int64 SessionAffinity会话时间,默认10800
示例值:

TxError

事务查询异常信息

被如下接口引用:RetryTransaction

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

DescribeSingleContainerGroupsResult

DescribeSingleContainerGroupsResult

被如下接口引用:DescribeSingleContainerGroups

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

CurvePoint

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

被如下接口引用:DescribeJvmMonitor

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

ServiceStatisticsResult

服务统计结果

被如下接口引用:DescribeStatistics

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

AddInstanceResult

添加实例到集群的结果

被如下接口引用:AddClusterInstances

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

GroupInfo

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

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

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

PagedProgram

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

被如下接口引用:DescribePrograms

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

TsfPageSimpleGroup

TSF简单部署组分页列表

被如下接口引用:DescribeSimpleGroups

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

DescribeResourceConfigLicense

DescribeResourceConfig

被如下接口引用:DescribeResourceConfig

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

FilebeatConfigPage

filebeat config 配置分页

被如下接口引用:DescribeFilebeatConfigPage

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

ResourceBatchOperationDescription

资源批次操作描述

被如下接口引用:DescribeResourceBatchOperation

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

ContainerVolumeOption

容器卷挂载信息

被如下接口引用:DescribeContainerVolumeOptions

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

ResourceTaskStatusResult

资源任务转态结果

被如下接口引用:DescribeResourceTaskStatus

名称 必选 允许NULL 类型 描述
TaskStatus Uint64 任务的执行状态
示例值:
TimeoutCount Uint64 超时任务数量
示例值:

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 任务节点数
示例值:

TsfPageUnitRuleV2

单元化规则翻页对象

被如下接口引用:DescribeUnitRulesV2

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

ImageTagsResult

镜像版本列表

被如下接口引用:DescribeImageTags

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

SchedulingStrategy

tsf 容器集群节点调度策略

被如下接口引用:DeployContainerGroup、DescribeContainerGroupDeployInfo

名称 必选 允许NULL 类型 描述
Type String NONE:不使用调度策略;CROSS_AZ:跨可用区部署
示例值:

MultiValueDataPoints

多值数据点集合

被如下接口引用:DescribeInvocationMetricScatterPlot

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

Release

发布单信息

被如下接口引用:DescribeReleases、DescribeSimpleReleases

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

UnitRuleResult

路由规则查询结果

被如下接口引用:DescribeUnitRouteConfig

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

ResourceFieldRef

k8s env 的 ResourceFieldRef

被如下接口引用:AnalyzeLogSchema、DeployContainerGroup、DescribeContainerGroupAttribute、DescribeContainerGroupDeployInfo、DescribeContainerGroupDetail、FindContainerGroup、ValidateLogSchema

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

ApplicationApiAccess

Serverless应用外网权限信息

被如下接口引用:DescribeApiAccess

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

ScalableSubRule

弹性扩缩容监控指标类型

被如下接口引用:CreateScalableRule、CreateScalableRuleWithDetailResp、ModifyScalableRule

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

GrayUnitRuleItem

规则项列表

被如下接口引用:ReleaseGrayUnitRouteRule

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

RatelimitRuleForUpdateV2

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

被如下接口引用:UpdateRatelimit

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

MultiValue

多值数据

被如下接口引用:DescribeInvocationMetricScatterPlot

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

MetricDataPoint

监控统计数据点

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

名称 必选 允许NULL 类型 描述
Key String 数据点键
示例值:
Value String 数据点值
示例值:
Tag 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 命名空间名字
示例值:

GroupDailyUseStatistics

分组日使用统计对象

被如下接口引用:DescribeGroupUseDetail

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

ApiUseStatisticsEntity

API 日统计数据点

被如下接口引用:DescribeApiUseDetail

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

HealthCheckSetting

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

被如下接口引用:DeployContainerGroup、DeployGroup、DescribeContainerGroupAttribute、DescribeContainerGroupDeployInfo、DescribeContainerGroupDetail、DescribeGroup、DescribeGroupAttribute、DescribeGroupOther、UpdateHealthCheckSettings

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

TsfPageAuthRule

TSF标准分页的AuthRule列表

被如下接口引用:DescribeAuthorizations

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

CircuitBreakerRule

熔断规则

被如下接口引用:DescribeCircuitBreakerRule、DescribeCircuitBreakerRules

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

PagedRole

tsf-privilege 模块 分页的Role列表

被如下接口引用:DescribeRoles

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

TsfPageFileConfigReleaseLog

文件配置项发布日志列表

被如下接口引用:DescribeFileConfigReleaseLogs

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

BusinessLogConfig

业务日志配置

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

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

DeploymentUnit

单元系统

被如下接口引用:DescribeUnitsByBusinessSystemIds

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

ShardArgument

分片参数

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

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

ThreadTraceGroupData

DescribeThreadDump 接口出参封装

被如下接口引用:DescribeThreadDump

名称 必选 允许NULL 类型 描述
TraceId String trace ID字串
示例值:
TraceString String trace字符串(栈信息)
示例值:
Count Int64 trace组线程数
示例值:

TaskRuleCheckResult

任务触发规则检查结果

被如下接口引用:CheckTaskRule

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

AuthDataMap

认证数据map

被如下接口引用:DescribeSecretList

名称 必选 允许NULL 类型 描述
Key String
示例值:
Value String
示例值:

TaskRecordPage

翻页查询的任务记录返回

被如下接口引用:DescribeTaskRecords

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

GroupPodResult

部署组实例列表

被如下接口引用:DescribePodInstances

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

TaskLastExecuteStatus

任务最近一次执行状态

被如下接口引用:DescribeTaskLastStatus

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

SidecarFilter

lua过滤器

被如下接口引用:DescribeSidecarFilter、DescribeSidecarFilters

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

TsfPageStdoutLogV2

标准输出日志列表

被如下接口引用:SearchRealtimeBusinessLog、SearchRealtimeStdoutLog、SearchStdoutLog

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

TsfZone

TSF可用区信息

被如下接口引用:DescribeTsfZones

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

TsfPageMonitorGroup

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

被如下接口引用:DescribeCloudMonitorGroups

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

TaskSpec

任务Spec

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

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

RatelimitRule

限流规则

被如下接口引用:DescribeApiRateLimitRuleList

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

ScalableRuleAttribute

ScalableRuleAttribute值

被如下接口引用:DescribeScalableRuleAttribute

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

HealthCheckConfig

健康检查配置

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

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

MicroserviceSummary

服务治理概要

被如下接口引用:DescribeMicroServiceSummaryList

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

CircuitBreakerRules

分页展示路由规则

被如下接口引用:DescribeCircuitBreakerRules

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

RepositoryInfo

仓库信息

被如下接口引用:DescribeRepositories、DescribeRepository

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

RatelimitRuleV2

限流规则

被如下接口引用:CreateRatelimit、DescribeRatelimit

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

TsfJvmLogPage

Jvm日志查询返回数据封装

被如下接口引用:DescribeJvmLogs

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

ImageListResult

镜像列表结果

被如下接口引用:DescribeImages

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

ESAuthInfo

es鉴权信息

被如下接口引用:GetApmEsAuthInfo

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

CosUploadInfo

cos上传所需信息

被如下接口引用:DescribeUploadInfo、GetUploadInfo

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

TsfPageInstance

TSF机器实例分页对象

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

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

FilebeatConfig

filebeat对象

被如下接口引用:DescribeFilebeatConfig、DescribeFilebeatConfigPage

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

InterfaceRequests

多条接口请求详情

被如下接口引用:DescribeInterfaceRequest

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

VmGroup

虚拟机部署组信息

被如下接口引用:DescribeGroup

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

ZipkinMetadata

调用链Span元数据

被如下接口引用:GetTraceSpans

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

CronSchedule

定时策略描述

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

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

TsfPageRouteV2

路由分页列表

被如下接口引用:DescribeRoutes

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

Event

事件

被如下接口引用:DescribeEventDetail

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

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
示例值:

OverviewClusterResourceUsage

集群概览页信息

被如下接口引用:DescribeClusterUsage

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

JavaFlameGraph

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

被如下接口引用:DescribeFlameGraph

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

OperationInfoDetail

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

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

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

Resource

tsf-privilege 模块,资源

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

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

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 自定义的分行值
示例值:

Tag

标签

被如下接口引用:DescribeLicenses

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

ContainerTasksResult

变更记录任务列表

被如下接口引用:ListContainerTask

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

ImageRepositorySecret

镜像仓库密钥

被如下接口引用:DescribeSecretList

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

ListScalableRuleResult

ListScalableRuleResult

被如下接口引用:ListScalableRule

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

TsfPageUnitNamespace

单元化命名空间翻页对象

被如下接口引用:DescribeUnitNamespaces、DescribeUsableUnitNamespaces

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

AuthRuleGroup

微服务权限规则组

被如下接口引用:DescribeAuthorizationType

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

ApmTaskAttr

APM 下发任务扩展参数

被如下接口引用:DescribeApmTaskStatus

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

MetricDataCurve

指标监控数据曲线

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

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

Gateway

网关

被如下接口引用:CreateAndReleaseArchConfig、ReleaseUnitGateways

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

GatewayQQMiniProgramLoginPlugin

微服务网关qq登录插件

被如下接口引用:DescribeGatewayQQMiniProgramLoginPlugin

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

ScalableTask

ScalableTask

被如下接口引用:ListScalableTasks

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

StatisticsEntry

概览页统计列表条目

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

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

UnitRouteRuleItem

路由规则内容

被如下接口引用:DescribeUnitRouteConfig

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

TsfRegion

TSF地域

被如下接口引用:DescribeTsfRegions

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

MethodDistData

DescribeThreadDump 接口出参封装

被如下接口引用:DescribeThreadDump

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

AgentProfile

部署javaagent的类型、版本信息

被如下接口引用:DeployContainerGroup、DeployGroup、DescribeContainerGroupDeployInfo、DescribeGroup、DescribeGroups

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

AppPkgList

应用的包列表

被如下接口引用:ListAppPkg

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

ThreadPicture

jvm监控数据线程数据封装

被如下接口引用:DescribeJvmMonitor

名称 必选 允许NULL 类型 描述
ThreadCount Array of CurvePoint 总线程数
示例值:查看
ThreadActive Array of CurvePoint 活跃线程数
示例值:查看
DeamonThreadCount Array of CurvePoint 守护线程数
示例值:查看

BusinessLogConfigSchema

业务日志配置解析规则

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

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

SidecarFilterGroup

过滤器关联的部署组

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

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

PagedService

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

被如下接口引用:DescribeServices

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

ThreadGroupData

DescribeThreadDump 接口出参封装

被如下接口引用:DescribeThreadDump

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

GatewayDeployGroup

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

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

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

FileConfigRelease

文件配置项发布信息

被如下接口引用:DescribeFileConfigReleases、DescribeGroupRelease

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

ReleaseGroup

发布单部署组

被如下接口引用:DescribeReleaseTemplate、ModifyReleaseTemplate

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

ContainGroup

部署组列表(应用下钻界面的)

被如下接口引用:DescribeContainerGroups、ListContainGroup

名称 必选 允许NULL 类型 描述
GroupId String 部署组ID
示例值:
GroupName String 分组名称
示例值:
CreateTime String 创建时间
示例值:
Server String 镜像server
示例值:
RepoName String 镜像名,如/tsf/nginx
示例值:
TagName String 镜像版本名称
示例值:
ClusterId String 集群ID
示例值:
ClusterName String 集群名称
示例值:
NamespaceId String 命名空间ID
示例值:
NamespaceName String 命名空间名称
示例值:
CpuRequest String 初始分配的 CPU 核数,对应 K8S request
示例值:
CpuLimit String 最大分配的 CPU 核数,对应 K8S limit
示例值:
MemRequest String 初始分配的内存 MiB 数,对应 K8S request
示例值:
MemLimit String 最大分配的内存 MiB 数,对应 K8S limit
示例值:
Alias String 部署组备注
示例值:
KubeInjectEnable Bool KubeInjectEnable值
示例值:
UpdatedTime String 更新时间
示例值:
UnitId String 单元ID
示例值:

DescribeSingleContainerGroups

部署组-独立菜单

被如下接口引用:DescribeSingleContainerGroups

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

ReleasePipelineTaskRunRecord

发布单任务执行记录

被如下接口引用:DescribeReleasePipelineTaskRunRecord

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

GroupInstanceUnified

DescribeGroupInstancesUnified 的单个结果

被如下接口引用:DescribeGroupInstancesUnified

名称 必选 允许NULL 类型 描述
AppId String 实例的 appid
示例值:
ClusterId String 实例的 cluster id
示例值:
NamespaceId String 实例的 namespace id
示例值:
GroupId String 实例的 group id
示例值:
ApplicationId String 实例的 application id
示例值:
InstanceId String 实例的 id
示例值:
InstanceName String 实例的名字
示例值:

InstanceRequests

多条实例请求详情

被如下接口引用:DescribeInstanceRequest

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

Ms

Ms

被如下接口引用:CreateAndDownloadTemplate、CreateTemplate

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

ZipkinTraceInfoV2

调用链信息

被如下接口引用:SearchTrace

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

VmTask

虚拟机操作记录

被如下接口引用:DscribeTasks

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

KubeNamespace

容器原生部署命名空间

被如下接口引用:DescribeContainerNamespaces、DescribeExtraKubeNamespaces

名称 必选 允许NULL 类型 描述
Name String 名称
示例值:
ClusterId String cluster id
示例值:
K8sNamespace String k8s namespace
示例值:

RecordV2

操作记录对象

被如下接口引用:DescribeRecords

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

ReleaseTaskRun

发布单任务执行状态

被如下接口引用:DescribeReleasePipelineRunTaskStatus

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

TsfPageApplication

应用分页信息

被如下接口引用:DescribeApplications

名称 必选 允许NULL 类型 描述
TotalCount Int64 应用总数目
示例值:
Content Array of ApplicationForPage 应用信息列表
示例值:查看

InvocationStatisticsRatio

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

被如下接口引用:DescribeInvocationStatisticsRatio

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

FileConfig

文件配置项

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

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

TsfPageMsRunningApplicationV2

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

被如下接口引用:DescribeMsRunningApplications

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

FunctionStatusResult

功能状态返回结果

被如下接口引用:DescribeFunctionStatus

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

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
示例值:

HealthCheckResult

健康检查结果

被如下接口引用:CheckUnitConfigService

名称 必选 允许NULL 类型 描述
Data String 扩展信息
示例值:
Enabled Bool 是否开启单元化
示例值:

OverviewClusterResourceUsageResult

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

被如下接口引用:DescribeClusterUsage

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

CloudMonitorMicroservice

CloudMonitorMicroservice

被如下接口引用:DescribeMicroServiceList、ListCloudMicroServiceFindPagedList

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

MicroServiceMetas

服务元数据

被如下接口引用:DescribeMicroserviceMetas

名称 必选 允许NULL 类型 描述
Type String 服务类型
示例值:
Key String 元数据key
示例值:
Value String 元数据value
示例值:

TemplateProject

ProjectList

被如下接口引用:DescribeTemplates

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

ContainerTaskDetail

容器任务详情

被如下接口引用:DescribeContainerTaskDetail

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

GCLogData

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

被如下接口引用:DescribeGCLog

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

AppIdEntity

租户ID

被如下接口引用:DescribeCurrentAppId

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

ContainerInfo

容器详细信息

被如下接口引用:DeployContainerGroup

名称 必选 允许NULL 类型 描述
Name String 容器名
示例值:
ContainerId String 容器ID
示例值:
Status String 容器状态
示例值:
Reason String 容器的Reason
示例值:
Image String 镜像地址
示例值:
CpuLimit String cpu limit
示例值:
CpuRequest String Cpu Request
示例值:
Envs Array of Env env
示例值:查看
InitContainerEnable Bool Enable InitContainer
示例值:
JvmOpts String Jvm Opts
示例值:
MemLimit String Mem Limit 
示例值:
MemRequest String Mem Request
示例值:
RepoName String Repo Name
示例值:
RepoType String Repo type
示例值:
SecretName String secret name 
示例值:
Server String image server
示例值:
TagName String tag name
示例值:
VolumeMountInfoList Array of VolumeMountInfo VolumeMountInfo List
示例值:查看
HealthCheckSettings Array of HealthCheckSetting HealthCheck Setting
示例值:查看

TsfPageMicroserviceSummary

服务治理概要page

被如下接口引用:DescribeMicroServiceSummaryList

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

BatchTemplate

分批分布模板

被如下接口引用:DescribeReleaseTemplate、ModifyReleaseTemplate

名称 必选 允许NULL 类型 描述
ApplicationId String 应用ID
示例值:
ApplicationType String 应用类型
示例值:
PackageId String 程序包ID
示例值:
RepoName String 镜像仓库名
示例值:
TagName String 镜像版本
示例值:
EnableApplicationConfig Bool 是否允许应用配置
示例值:
PriorApplicationConfig Bool 是否先进行应用配置发布,再部署程序
示例值:
ApplicationConfigs Array of ApplicationConfig 应用配置列表
示例值:查看
EnableFileConfig Bool 是否允许文件配置
示例值:
FileConfigs Array of FileConfig 文件配置列表
示例值:查看
BatchGroups Array of BatchGroup 分批部署组列表
示例值:查看
ApplicationName String 应用名
示例值:
PackageName String 包名
示例值:
PackageVersion String 包版本
示例值:
RepoType String 镜像仓库类型
示例值:

Provider

provider

被如下接口引用:CreateAndDownloadTemplate、CreateTemplate

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

NamespaceServiceOverview

命名空间维度的服务概览

被如下接口引用:DescribeNamespaceServiceOverview

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

GatewayPluginModel

GatewayPluginModel

被如下接口引用:DescribeGatewayWithPlugin

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

MicroserviceGroup

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

被如下接口引用:DescribeMicroserviceGroups

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

PurchaseInfo

购买信息

被如下接口引用:DescribeUserPurchaseInfo

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

TsfPageVmSubTask

虚拟机子任务分页信息

被如下接口引用:DescribeSubTasks

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

EnvsV2

环境变量

被如下接口引用:AnalyzeLogSchema、DescribeContainerGroupDeployInfo、ValidateLogSchema

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

TsfPageContainerEvent

分页的 ContainerEvent

被如下接口引用:DescribeContainerEvents

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

LicenseTag

许可标签

被如下接口引用:DescribeLicenses

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

InvocationStatisticsV2

服务调用统计

被如下接口引用:DescribeInvocationStatistics、DescribeInvocationStatisticsRatio

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

TsfPrice

Tsf 询价返回

被如下接口引用:DescribePrice

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

GatewayGroupIds

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

被如下接口引用:BindApiGroup、UnbindApiGroup

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

TsfPageCluster

Tsf分页集群对象

被如下接口引用:DescribeSimpleClusters

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

PkgList

包列表

被如下接口引用:DescribePkgs、ListPkg

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

OperateKubeInjectResult

OperateKubeInjectResult值

被如下接口引用:OperateKubeInject

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

LaneRule

泳道规则

被如下接口引用:DescribeLaneRule、DescribeLaneRules

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

TsfEventAttribute

事件属性

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

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

LaneGroups

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

被如下接口引用:DescribeLaneGroups

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

ReleasePipeline

发布单流水线信息

被如下接口引用:DescribeReleasePipeline

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

DeliveryConfigBindGroups

描述配置项绑定的部署组

被如下接口引用:DescribeDeliveryConfigs

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

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
示例值:

BuildTaskInfo

构建任务信息

被如下接口引用:DescribeBuildTasks

名称 必选 允许NULL 类型 描述
BuildTaskId String 构建任务id
示例值:
Status String - STOP
未启动
- BUILDING
构建中
- BUILD_SUCCESS
构建成功
- BUILD_FAILED
构建失败
- CANCEL
用户取消
示例值:
PackageName String 构建包的名称
示例值:
ErrorMessage String 构建失败的原因
示例值:
StartTime Uint64 开始时间,unix 时间戳,精确到毫秒。
示例值:
EndTime Uint64 结束时间,unix 时间戳,精确到毫秒。
示例值:
Tag String 镜像版本
示例值:

TsfPageMicroserviceGroup

微服务下部署组列表

被如下接口引用:DescribeMicroserviceGroups

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

ApiGroupInfo

API分组信息

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

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

DeleteImageTag

需要删除的镜像版本

被如下接口引用:DeleteImageTags

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

TsfPageBillingOperationRecord

BillingOperationRecord 翻页对象

被如下接口引用:DescribeBillingOperationRecords

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

GroupPod

部署组实例列表

被如下接口引用:DescribePodInstances

名称 必选 允许NULL 类型 描述
PodName String 实例名称(对应到kubernetes的pod名称)
示例值:
PodId String 实例ID(对应到kubernetes的pod id)
示例值:
Status String 实例状态,请参考后面的实例以及容器的状态定义。启动中(pod 未 ready):Starting;运行中:Running;异常:Abnormal;停止:Stopped;
示例值:
Reason String 实例处于当前状态的原因,例如容器下载镜像失败
示例值:
NodeIp String 主机IP
示例值:
Ip String 实例IP
示例值:
RestartCount Int64 实例中容器的重启次数
示例值:
ReadyCount Int64 实例中已就绪容器的个数
示例值:
Runtime String 运行时长
示例值:
CreatedAt String 实例启动时间
示例值:
ServiceInstanceStatus String 服务实例状态
示例值:
InstanceAvailableStatus String 机器实例可使用状态
示例值:
InstanceStatus String 机器实例状态
示例值:
NodeInstanceId String 节点实例id
示例值:
Containers Array of PodContainer Containers
示例值:查看

RouterIdentifier

路由要素配置

被如下接口引用:CreateAndReleaseUnitRouteConfig

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

TsfPageClusterV2

Tsf分页集群对象

被如下接口引用:DescribeClusters

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

CosDownloadInfo

Cos下载所需信息

被如下接口引用:DescribeDownloadInfo、GetDownloadInfo

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

AppPkgInfo

应用的包信息

被如下接口引用:ListAppPkg

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

TsfPageRecordV2

操作记录列表对象

被如下接口引用:DescribeRecords

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

MetricDataPointMap

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

被如下接口引用:DescribeUnitApiUseDetail

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

GroupUnitApiUseStatistics

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

被如下接口引用:DescribeUnitApiUseDetail

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

ReleaseStage

发布单阶段信息

被如下接口引用:DescribeReleasePipeline、DescribeReleasePipelineRun

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

MsApiArray

微服务API数组

被如下接口引用:DescribeInterfaceList、DescribeMsApiList

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

DescribeResourceConfigResultV2

DescribeResourceConfig

被如下接口引用:DescribeResourceConfig

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

TsfPageFileConfig

文件配置项列表

被如下接口引用:DescribeFileConfigSummary、DescribeFileConfigs

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

GatewayVo

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

被如下接口引用:DescribeGatewayAllGroupApis

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

AdvanceSettings

高级选项设置

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

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

TcrRepoInfo

tcr仓库信息

被如下接口引用:CreateBuildTask、DescribeContainerGroupDeployInfo、DescribeImageRepository、DescribeImageTags、ImageGetRepositoryList、OperateApplicationTcrBinding

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

ImageRepositoryResult

镜像仓库列表

被如下接口引用:DescribeImageRepository、ImageGetRepositoryList

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

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
示例值:

RuleConfig

规则配置

被如下接口引用:CreateAndReleaseUnitRouteConfig

名称 必选 允许NULL 类型 描述
RuleConfigName String 规则项名称
示例值:
Conditions Array of Condition 标签匹配
示例值:查看
ConditionOperator String  标签逻辑关系, 支持 AND/OR
示例值:
TargetUnitId String 目标单元id
示例值:
TargetUnitName String 目标单元名称
示例值:
CloudSpaceName String 云空间名称
示例值:

GatewayPluginId

微服务网关插件Id

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

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

PathRewritePage

路径重写翻页对象

被如下接口引用:DescribePathRewrites

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

RouteRuleV2

路由规则项

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

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

EventFilter

事件过滤器

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

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

ContainerAdditionalResourceRequirementMap

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

被如下接口引用:DescribeResourceConfig

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

DescribeResourceConfigClusterContainer

返回给前端的控制信息

被如下接口引用:DescribeResourceConfig

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

GroupResourceConfig

部署组相关的参数配置

被如下接口引用:DescribeResourceConfig

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

DescribeResourceConfigLicenseFunction

DescribeResourceConfig

被如下接口引用:DescribeResourceConfig

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

SpanLabel

Span标签

被如下接口引用:DescribeSpanDetail、GetTraceSpans、SearchSpan

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

LogCapacity

analyst 日志限制

被如下接口引用:DescribeLogCapacity

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

ESUserInfo

es用户信息

被如下接口引用:GetApmEsAuthInfo

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

FindContainerGroupResult

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

被如下接口引用:FindContainerGroup

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

DeliveryConfigBindGroup

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

被如下接口引用:DescribeAssociateRelation、DescribeDeliveryConfigs

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

TsfPageLicenseTag

LicenseTag 翻页对象

被如下接口引用:DescribeLicenses

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

Env

环境变量

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

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

JavaInstance

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

被如下接口引用:DescribeJavaInstance

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

VolumeInfo

容器卷挂载信息

被如下接口引用:DeployContainerGroup、DescribeContainerGroupDeployInfo

名称 必选 允许NULL 类型 描述
VolumeType String 数据卷类型
示例值:
VolumeName String 数据卷名称
示例值:
VolumeConfig String 数据卷配置
示例值:
VolumeClaimTemplateOption VolumeClaimTemplateOption 动态pvc配置
示例值:查看

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 地址
示例值:

Result

FindMonitorObject返回的结果

被如下接口引用:FindMonitorObject、FindServiceMonitorObject

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

WarmupSetting

预热配置

被如下接口引用:DeployContainerGroup、DeployGroup、DescribeContainerGroupDeployInfo、DescribeGroup、DescribeGroups

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

MonitorStatisticsPolicyGroup

MonitorStatisticsPolicyGroup

被如下接口引用:DescribeMonitorStatisticsPolicy、ListMonitorStatisticsPolicy

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

VolumeItem

容器卷挂载项信息

被如下接口引用:DescribeContainerVolumeOptions

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

PodContainer

PodContainer

被如下接口引用:DescribePodInstances

名称 必选 允许NULL 类型 描述
Name String
示例值:
ContainerId String
示例值:
Status String
示例值:
Reason String
示例值:
Image String
示例值:
ImageId String
示例值:
ContainerRestartCount Int64
示例值:
CpuLimit String
示例值:

TsfPageApiGroupInfo

ApiGroupInfo翻页结构体

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

名称 必选 允许NULL 类型 描述
TotalCount Int64 总记录数
示例值:
Content Array of ApiGroupInfo API分组信息
示例值:查看

UnitRouteRuleTag

单元化规则标签

被如下接口引用:DescribeUnitRouteConfig

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

ImageUserIsExistsResult

ImageUserIsExistsResult

被如下接口引用:DescribeImageUserIsExists

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

UnitCloudArchitectureResult

单元化架构结果

被如下接口引用:DescribeArchConfig

名称 必选 允许NULL 类型 描述
Dus Array of DU SDU和GDU
示例值:查看
BusinessSystems Array of BusinessSystem 业务系统
示例值:查看
Namespaces Array of UnitArchNamespace 命名空间列表
示例值:查看

ResourceGetBatchIndexResult

获取执行批次索引的描述

被如下接口引用:GetResourceBatchIndex

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

TsfPageGatewayDeployGroup

GatewayDeployGroup 翻页对象

被如下接口引用:DescribeGroupBindedGateways、DescribeUsableGatewayGroups

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

TsfPageSimpleApplication

TSF分页简单应用对象

被如下接口引用:DescribeSimpleApplications

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

InterfaceStatistic

接口统计

被如下接口引用:DescribeInterfaceStatistic

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

ApiInfo

微服务网关API信息

被如下接口引用:CreateGatewayApi

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

TsfPageRelease

发布单信息列表

被如下接口引用:DescribeReleases、DescribeSimpleReleases

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

TsfPageTraceService

调用链服务名列表

被如下接口引用:GetTraceServices

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

ApiRateLimitRule

微服务网关API限流规则

被如下接口引用:DescribeApiRateLimitRules

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

JvmLockDetail

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

被如下接口引用:RunJvmDeadLockCheck

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

TagRouteItemList

标签路由规则

被如下接口引用:CreateRouteRule、DescribeRouteReleaseHistory

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

ReleaseTemplate

发布单模板

被如下接口引用:DescribeReleaseTemplate

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

DescribeResourceConfigLicenseResource

DescribeResourceConfig

被如下接口引用:DescribeResourceConfig

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

LaneGroup

泳道部署组

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

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

EventStatisticsResult

事件统计内容

被如下接口引用:DescribeEventStatistics

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

OverviewResource

资源概览数据信息

被如下接口引用:DescribeOverviewResource

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

InvocationMetricDataPoint

InvocationMetricDataPoint

被如下接口引用:DescribeUnitApiUseDetail

名称 必选 允许NULL 类型 描述
Key String Key
示例值:
Value String Value
示例值:
Tag String Tag
示例值:

MetricDimension

指标维度

被如下接口引用:DescribeInvocationMetricDataCurve、DescribeInvocationMetricScatterPlot

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

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 当前环境对应的云空间
示例值:查看

RouteDestV2

服务路由目标规则

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

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

GetClusterLimitResourceResult

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

被如下接口引用:GetClusterLimitResource

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

MetricDimensionValue

指标维度多值匹配

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

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

GroupsByScalableRuleId

GroupsByScalableRuleId

被如下接口引用:DescribeScalableRuleAttributeByGroup、ListGroupsByScalableRuleId

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

ExpandSubrule

ExpandSubrule

被如下接口引用:DescribeScalableRuleAttribute

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

GatewayTagPlugin

微服务网关TAG插件明细

被如下接口引用:DescribeGatewayTagPlugin

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

ConfigRelease

配置项发布信息

被如下接口引用:DescribeConfigReleases、DescribeGroupRelease、DescribePublicConfigReleases

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

TaskRecord

任务定义

被如下接口引用:DescribeTaskDetail、DescribeTaskRecords

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

MultipartPkg

分片包详情

被如下接口引用:DownloadMultipartPkg

名称 必选 允许NULL 类型 描述
PkgId String 程序包ID
示例值:
FileSeg Uint64 当前分片
示例值:
FileSegments Uint64 总分片数
示例值:
SegmentSize Uint64 每个分片的大小 (字节数)
示例值:
Md5 String 文件的MD5
示例值:
Size Uint64 文件大小(总字节数)
示例值:
File String 文件编码数据 (@为首,表示base64编码)
示例值:

TsfPageZone

TSF可用区列表对象

被如下接口引用:DescribeTsfZones

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

TsfPageReleaseRunInfo

发布单执行信息

被如下接口引用:DescribeReleasePipelineRuns

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

GraphNodeV2

依赖拓扑图节点

被如下接口引用:GetTopologyGraph

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

LaneInfos

泳道分页查询

被如下接口引用:DescribeLanes

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

Instance

机器实例

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

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

ApplicationAttribute

应用列表其它字段

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

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

ContainerGroupPlainYaml

部署组简单 Yaml

被如下接口引用:DescribeContainerGroupPlainYaml

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

EventStatistics

事件统计结果

被如下接口引用:DescribeEventStatistics

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

TsfPageConfigRelease

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

被如下接口引用:DescribeConfigReleases、DescribePublicConfigReleases

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

TaskId

任务id

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

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

OverviewInstanceResourceUsage

实例相关信息概览

被如下接口引用:DescribeInstanceResourceUsage

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

TemplateResult

TemplateResult

被如下接口引用:DescribeTemplates

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

UnitNamespace

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

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

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

MsRunningApplicationV2

微服务应用信息

被如下接口引用:DescribeMsRunningApplications

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

TsfPageBusinessLogConfig

业务日志配置项列表

被如下接口引用:DescribeBusinessLogConfigs、DescribeGroupBusinessLogConfigs

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

TsfPageSimpleNamespace

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

被如下接口引用:DescribeGeneralMetricDataDimension

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

VmSubTask

虚拟机子任务信息

被如下接口引用:DescribeSubTasks

名称 必选 允许NULL 类型 描述
InstanceId String 机器Id
示例值:
LanIp String 内网IP
示例值:
WanIp String 外网IP
示例值:
InstanceName String 机器名称
示例值:
AgentState Int64 机器Agent状态
示例值:
InstanceState Int64 机器状态
示例值:
TaskStatus Int64 任务状态
示例值:
TaskRecord String 任务记录
示例值:
Reason String 执行结果原因
示例值:

ChangeOrderDetail

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 分区
示例值:

LaneRuleTag

泳道规则标签

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

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

TsfPageGroupInstanceUnified

DescribeGroupInstancesUnified 的结果

被如下接口引用:DescribeGroupInstancesUnified

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

EventDataCurveResult

事件趋势线

被如下接口引用:DescribeEventTrend

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

SimpleKafkaDeliveryConfig

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

被如下接口引用:DescribeDeliveryConfigByGroupId

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

AbnormalMetricsConfig

服务监控异常指标配置

被如下接口引用:DescribeAbnormalMetricsConfig

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

InstanceSummary

实例监控统计总览

被如下接口引用:DescribeInstanceMetrics

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

ZipkinEndPoint

调用链Span端点信息

被如下接口引用:GetTraceSpans

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

Ports

服务端口

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

名称 必选 允许NULL 类型 描述
TargetPort Uint64 服务端口
示例值:
Protocol String 端口协议
示例值:

TsfPageGatewayPluginModel

TsfPageGatewayPluginModel

被如下接口引用:DescribeGatewayWithPlugin

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

KubeDeploymentPage

容器轻量化Deployment Page

被如下接口引用:DescribeKubeDeployments

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

PagedPermCat

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

被如下接口引用:DescribePermissionCategories

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

CheckTsfUnitResult

tsf单元化配置详情

被如下接口引用:CheckTsfUnitSupported

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

SimpleGroup

部署组

被如下接口引用:DescribeSimpleGroups

名称 必选 允许NULL 类型 描述
GroupId String 部署组ID
示例值:
GroupName String 部署组名称
示例值:
ApplicationId String 应用ID
示例值:
ApplicationName String 应用名称
示例值:
ApplicationType String 应用类型
示例值:
ClusterId String 集群ID
示例值:
ClusterName String 集群名称
示例值:
ClusterType String 集群类型
示例值:
NamespaceId String 命名空间ID
示例值:
NamespaceName String 命名空间名称
示例值:
StartupParameters String 启动参数
示例值:
GroupResourceType String 部署组资源类型
示例值:
AppMicroServiceType String 应用微服务类型
示例值:
JdkName String JdkName
示例值:
JdkVersion String JdkVersion
示例值:
ServiceAgentVersion String ServiceAgentVersion
示例值:
StartScript String StartScript
示例值:
GatewayConfig String GatewayConfig
示例值:
Status String Status
示例值:
WarmupSetting String WarmupSetting
示例值:
UpdateType Int64 UpdateType
示例值:
KubeInjectEnable Bool KubeInjectEnable
示例值:
ServiceSpecEncode String ServiceSpecEncode
示例值:
StopScript String StopScript
示例值:
Alias String Alias
示例值:
OtAgentVersion String OtAgentVersion
示例值:
UnitType String 单元类型
示例值:
UnitEnvType String 单元环境类型
示例值:
EnabledUnit Bool 是否单元化
示例值:
EnableBatchHealthCheck Bool 是否开启分批健康检查
示例值:
UnitName String 单元名
示例值:
BusinessSystemName String
示例值:
K8sNamespaceName String
示例值:
UnitId String 单元id
示例值:

PropertyField

属性字段

被如下接口引用:DescribeApiDetail

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

TsfPageMicroServiceMetas

分页元数据结构

被如下接口引用:DescribeMicroserviceMetas

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

RatelimitDimension

限流规则作用的标签维度

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

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

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
示例值:

GraphEdgeV2

依赖拓扑图边

被如下接口引用:GetTopologyGraph

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

GroupUseStatisticsEntity

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

被如下接口引用:DescribeGroupUseDetail

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

ApiDetailResponse

ApiDetailResponse描述

被如下接口引用:DescribeApiDetail

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

QuantileEntity

分位数据模型

被如下接口引用:DescribeApiUseDetail、DescribeUnitApiUseDetail

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

ValueFrom

k8s env 的 ValueFrom

被如下接口引用:AnalyzeLogSchema、DeployContainerGroup、DescribeContainerGroupAttribute、DescribeContainerGroupDeployInfo、DescribeContainerGroupDetail、FindContainerGroup、ValidateLogSchema

名称 必选 允许NULL 类型 描述
FieldRef FieldRef k8s env 的 FieldRef
示例值:查看
ResourceFieldRef ResourceFieldRef k8s env 的 ResourceFieldRef
示例值:查看

DescribeResourceConfigCluster

返回给前端的控制信息

被如下接口引用:DescribeResourceConfig

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

InstanceMetricDataCurve

实例监控数据曲线信息

被如下接口引用:DescribeInstanceMonitorDetails

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

ServiceStatisticsResults

服务统计结果集

被如下接口引用:DescribeStatistics

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

ContainerGroupDeploy

获取部署组

被如下接口引用:DescribeContainerGroupDeployInfo

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

TsfPageUnitRule

单元化规则翻页对象

被如下接口引用:DescribeUnitRules

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

OverviewConfig

概览页配置

被如下接口引用:DescribeResourceUsageConfig

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

Namespace

命名空间

被如下接口引用:DescribeNamespaces、DescribeSimpleNamespaces

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

PathRewrite

路径重写

被如下接口引用:DescribePathRewrite、DescribePathRewrites

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

WeightRouteItemList

权重路由规则项

被如下接口引用:CreateRouteRule、DescribeRouteReleaseHistory

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

DescribeContainerTasksResult

DescribeContainerTasksResult

被如下接口引用:DescribeContainerTasks

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

GroupApiUseStatistics

API监控明细数据

被如下接口引用:DescribeApiUseDetail

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

Metric

指标

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

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

VmGroupOther

虚拟机部署组其他字段

被如下接口引用:DescribeGroupAttribute、DescribeGroupOther

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

DescribeResourceConfigSts

DescribeResourceConfig

被如下接口引用:DescribeResourceConfig

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

TsfPageReleaseTaskRun

发布单任务执行分页信息

被如下接口引用:DescribeReleasePipelineRunTaskStatus

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

ContainerAdditionalResourceRequirement

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

被如下接口引用:DescribeResourceConfig

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

EventDataPointResult

事件趋势曲线点

被如下接口引用:DescribeEventTrend

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

ImageTag

列表信息

被如下接口引用:DescribeImageTags

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

Interface

描述接口信息

被如下接口引用:DescribeInstanceRequest

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

TsfPageApiDetailInfo

ApiDetailInfo 翻页对象

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

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

TsfPageInvocationStatisticsV2

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

被如下接口引用:DescribeInvocationStatistics

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

SimpleNamespace

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

被如下接口引用:DescribeGeneralMetricDataDimension

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

TsfPageRegion

TSF地域列表对象

被如下接口引用:DescribeTsfRegions

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

BillingConfig

计费配置

被如下接口引用:DescribeBillingConfig

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

ReleaseRunInfo

发布单执行信息

被如下接口引用:DescribeReleasePipelineRuns

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

CronRule

定时弹性扩缩容规则描述

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

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

AlarmOverviewContent

告警记录概览页信息

被如下接口引用:DescribeAlarmOverviewList

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

RouteAffinity

路由规则就近访问策略

被如下接口引用:DescribeNamespaceAffinities

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

CloudMonitorPolicyResult

云监控对象策略对象

被如下接口引用:ListColudMonitorStatisticsPolicy

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

VmInstanceResourceConfig

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

被如下接口引用:DescribeResourceConfig

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

VolumeMountInfo

容器卷挂载点信息

被如下接口引用:DeployContainerGroup、DescribeContainerGroupDeployInfo

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

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 任务扩展字段
示例值:查看

TsfPageInstanceMetrics

分页实例监控指标信息

被如下接口引用:DescribeInstanceMetrics

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

ContainerGroupOther

部署组列表-其它字段

被如下接口引用:DescribeContainerGroupAttribute

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

MonitorStatisticsPolicy

MonitorStatisticsPolicy值

被如下接口引用:DescribeMonitorStatisticsPolicy、ListMonitorStatisticsPolicy

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

CommonGroupAttribute

通用部署组额外属性

被如下接口引用:DescribeCommonGroupAttribute

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

JvmLog

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

被如下接口引用:DescribeJvmLogs

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

ApiDetailInfo

API 明细

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

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

GatewayNamespace

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

被如下接口引用:DescribeAuthNamespaces

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

CloudMonitorMicroserviceResult

CloudMonitorMicroserviceResult

被如下接口引用:DescribeMicroServiceList、ListCloudMicroServiceFindPagedList

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

PermCat

tsf-privilege 模块 PermissionCategory 权限组

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

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

ResourceBatchOperationStatusResult

描述批次操作的执行结果

被如下接口引用:ContinueResourceBatchOperation

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

BusinessSystem

业务系统

被如下接口引用:CreateAndReleaseArchConfig、DescribeArchConfig、DescribeUnitBusinessSystems

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

MethodProfile

方法执行分析

被如下接口引用:DescribeJvmMonitorMethodProfile

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

TsfPageVmGroup

列表中部署组分页信息

被如下接口引用:DescribeGroups

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

GatewayPlugin

微服务网关插件实例对象

被如下接口引用:DescribeGatewayPlugins、DescribePluginInstances

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

ApiRequestDescr

ApiRequestDescr

被如下接口引用:DescribeApiDetail

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

SidecarStatus

sidecar 状态

被如下接口引用:DescribeMeshSidecarStatus

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

LaneRules

泳道规则分页查询

被如下接口引用:DescribeLaneRules

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

InstanceInfo

实例信息

被如下接口引用:DescribeInterfaceRequest

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

TsfPageAppIdEntity

TsfPage,当前租户ID

被如下接口引用:DescribeCurrentAppId

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

RatelimitListResult

none

被如下接口引用:DescribeRatelimit

名称 必选 允许NULL 类型 描述
TotalCount Uint64 总数
示例值:
Content Array of RatelimitRuleV2 列表内容
示例值:查看

OverviewBasicResourceUsage

TSF基本资源信息概览

被如下接口引用:DescribeBasicResourceUsage

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

TsfPageMicroservice

微服务列表信息

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

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

ResourcePoolInstance

弹性伸缩资源池实例

被如下接口引用:DescribeResourcePoolInstances

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

UnitRuleObject

单元化规则

被如下接口引用:DescribeUnitRouteConfig

名称 必选 允许NULL 类型 描述
Id String 规则id
示例值:
Name String 规则名称
示例值:
Description String 描述
示例值:
UnitRuleItemList Array of UnitRouteRuleItem 规则内容
示例值:查看
CustomerIdModValue String 客户号模除值
示例值:
UpdatedTime String 更新时间戳
示例值:
UpdatedShowTime String 更新时间,由UpdatedTime转换而来,用于前端展示
示例值:
CustomerIdTag String 客户标签名称
示例值:

BusinessLogPatternAnalysis

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

被如下接口引用:AnalyzeLogSchema、ValidateLogSchema

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

ViewInfo

视图信息

被如下接口引用:DescribeViews

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

ApiDailyUseStatisticsEntity

ApiDailyUseStatisticsEntity

被如下接口引用:DescribeUnitApiUseDetail

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

TsfPageNamespaceServiceOverview

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

被如下接口引用:DescribeNamespaceServiceOverview

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

TsfPageRouteAffinity

TSF就近访问列表对象

被如下接口引用:DescribeNamespaceAffinities

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

InvocationIndicator

服务调用监控指标

被如下接口引用:DescribeInovcationIndicators

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

PathRewriteCreateObject

路径重写创建对象

被如下接口引用:CreatePathRewrites

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

UnitRuleItem

微服务网关单元化规则项

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

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

LaneInfo

泳道

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

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

PkgInfo

包信息

被如下接口引用:DescribePkgs、ListPkg

名称 必选 允许NULL 类型 描述
PkgId String 程序包ID
示例值:
PkgName String 程序包名
示例值:
PkgType String 程序包类型
示例值:
PkgVersion String 程序包版本
示例值:
PkgDesc String 程序包描述
示例值:
UploadTime String 上传时间
示例值:
Md5 String 程序包MD5
示例值:
PkgPubStatus Int64 程序包状态
示例值:
PkgBindInfo Array of PkgBind 程序包关联关系
示例值:查看
PkgSdkVersion String 程序包sdk版本
示例值:
UseOT String 是否使用OT
示例值:
OtAgentVersion String OT 的版本
示例值:

SidecarMetrics

sidecar监控指标

被如下接口引用:DescribeSidecarMetrics

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

TraceSpanDetail

span查询的出参

被如下接口引用:DescribeSpanDetail

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

TsfConfig

TSF配置

被如下接口引用:DescribeResourceTsfConfig、ModifyResourceMultiCloudTsfConfig

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

TsfPageGatewayPlugin

GatewayPlugin 翻页对象

被如下接口引用:DescribeGatewayPlugins、DescribePluginInstances

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

FieldRef

容器 env 的 FieldRef

被如下接口引用:AnalyzeLogSchema、DeployContainerGroup、DescribeContainerGroupAttribute、DescribeContainerGroupDeployInfo、DescribeContainerGroupDetail、FindContainerGroup、ValidateLogSchema

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

ApiStatusResponse

API在线状态

被如下接口引用:DescribeApiStatus

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

VisitAccount

体验账号

被如下接口引用:DescribeVisitAccount

名称 必选 允许NULL 类型 描述
VisitAppId String
示例值:
VisitUin String
示例值:
VisitName String
示例值:
VisitSubAccountUin String
示例值:
VisitPassword String
示例值:
CreateTime String
示例值:
ExpireTime String
示例值:
Full Bool 是否满人
示例值:
Visit Bool 当前是否体验账号
示例值:

DeployContainerGroupByPlainYamlResult

DeployContainerGroupByPlainYaml 的结果

被如下接口引用:DeployContainerGroupByPlainYaml

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

AuthRule

微服务权限规则

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

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

SDUTrafficRule

SDU -> GDU 转换规则

被如下接口引用:CreateAndReleaseArchConfig

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

DailyUseStatistics

日使用统计对象

被如下接口引用:DescribeGatewayDailyUseStatistics

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

InstanceReleasedConfig

实例发布配置

被如下接口引用:DescribeInstanceReleasedConfig

名称 必选 允许NULL 类型 描述
MemoryConfig String 实例内存生效配置(相关key限定在tsf下发配置范围内)
示例值:
ReleaseConfig String 查询发布的配置,包括应用配置和全局配置
示例值:

ResourcePool

虚机弹性伸缩资源池对象

被如下接口引用:DescribeResourcePools

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

CtsdbInfo

CTSDB配置信息

被如下接口引用:DescribeResourceTsfConfig、ModifyResourceMultiCloudTsfConfig

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

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
示例值:

ThreadStateData

DescribeThreadDump 接口出参封装

被如下接口引用:DescribeThreadDump

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

TsfPageFileConfigRelease

文件配置项发布信息列表

被如下接口引用:DescribeFileConfigReleases

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

TypeCode

术语描述对象,码表

被如下接口引用:DescribeRecordCodes

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

CloudMonitorPolicies

云监控对象策略对象

被如下接口引用:ListColudMonitorStatisticsPolicy

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

Controller

tsf模板

被如下接口引用:CreateAndDownloadTemplate、CreateTemplate

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

ContainerGroupDetail

容器部署组详情

被如下接口引用:DescribeContainerGroupDetail

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

ConsulAccessInfo

注册中心接入配置信息

被如下接口引用:DescribeResourceTsfConfig、ModifyResourceMultiCloudTsfConfig

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

RepositoryList

仓库列表

被如下接口引用:DescribeRepositories

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

BlueGreenTemplate

蓝绿发布模板

被如下接口引用:DescribeReleaseTemplate、ModifyReleaseTemplate

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

BillingLicense

计费许可

被如下接口引用:DescribeAllBillingLicenses

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

TsfPageZipkinSpanInfo

调用链Span列表

被如下接口引用:GetTraceSpans

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

DU

单元信息

被如下接口引用:DescribeArchConfig、DescribeDeploymentUnits、DescribeUnitsByBusinessSystemIds

名称 必选 允许NULL 类型 描述
UnitId String 单元id
示例值:
UnitName String 单元名称
示例值:
ZoneId String 可用区id
示例值:
ZoneName String 可用区名称
示例值:
UnitType String 单元类型 Global 代表 GDU,Standard 代表 SDU
示例值:
UnitEnvType String 单元环境类型 Prod/Gray
示例值:

FileConfigReleaseLog

文件配置项发布日志

被如下接口引用:DescribeFileConfigReleaseLogs

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

GetContainGroupDeployInfo

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

被如下接口引用:GetContainGroupDeployInfo

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

ImageFeature

镜像特征

被如下接口引用:DescribeImageFeatures

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

InstanceRequest

单条实例请求详情

被如下接口引用:DescribeInstanceRequest

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

ThreadDetailInfos

线程详情信息数组

被如下接口引用:DescribeThreadDetailList

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

ApiResponseDescr

API 响应的参数结构描述

被如下接口引用:DescribeApiDetail

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

TsfPageBillingDeal

BillingDeal 翻页对象

被如下接口引用:DescribeBillingDealRecords

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

GroupRelease

部署组配置发布相关信息

被如下接口引用:DescribeGroupRelease

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

MetricStatistic

网关监控统计信息

被如下接口引用:DescribeGatewayMonitorDetails

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

TsfPageDimension

维度分页

被如下接口引用:DescribeInvocationMetricDataDimension

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

UnitRuleTag

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

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

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

MsInstance

微服务实例信息

被如下接口引用:DescribeMicroservice

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

UnitRule

微服务网关单元化规则

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

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

ResultStatus

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

被如下接口引用:CreateFlameGraph、SetJvmMonitorMethodProfile

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

ScalableTaskResult

ScalableTaskResult

被如下接口引用:ListScalableTasks

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

Role

tsf-privilege模块 Role 角色

被如下接口引用:DescribeRole、DescribeRoles

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

OperationInfo

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

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

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

ThreadDump

DescribeThreadDump 接口返回的数据列表

被如下接口引用:DescribeThreadDump

名称 必选 允许NULL 类型 描述
Data Array of ThreadDumpData 线程分析结果
示例值:查看
Status String 接口执行状态success/error
示例值:
StatusInfo String success时为"", error时为错误信息
示例值:
StatusCode Int64 success时为, error时为错误码
示例值:

UnitApiDailyUseStatistics

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

BusinesLogConfigAssociatedGroup

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

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

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

TxRetry

事务重试接口出参

被如下接口引用:RetryTransaction

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

EventSort

事件排序器

被如下接口引用:DescribeEventDetail、DescribeEventStatistics

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

DailyUseStatisticsEntity

日统计数据节点

被如下接口引用:DescribeGatewayDailyUseStatistics

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

Error

检测sdk版本错误信息

被如下接口引用:DetectSdkVersion

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

GatewayPluginBoundParam

微服务网关插件绑定对象

被如下接口引用:BindPlugin、UnbindPlugin

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

TsfPageZipkinTraceInfoV2

调用链列表

被如下接口引用:SearchTrace

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

DetectPkgReply

sdk检测结果

被如下接口引用:DetectSdkVersion

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

ServiceStatistics

服务运行统计指标

被如下接口引用:GetServiceStatistics

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

ConfigReleaseLog

配置项发布日志

被如下接口引用:DescribeConfigReleaseLogs、DescribePublicConfigReleaseLogs

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

RouteRule

路由规则信息

被如下接口引用:DescribeRouteReleaseHistory

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

CreateContainerShellSessionResult

CreateContainerShellSession 的 result

被如下接口引用:CreateContainerShellSession

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

TsfPageNamespace

Tsf命名空间分页对象

被如下接口引用:DescribeNamespaces、DescribeSimpleNamespaces

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

ProtocolPort

端口对象

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

名称 必选 允许NULL 类型 描述
Protocol String TCP UDP
示例值:
Port Int64 服务端口
示例值:
TargetPort Int64 容器端口
示例值:
NodePort Int64 主机端口
示例值:
Name String
示例值:

OverviewGroupResourceUsage

部署组统计信息

被如下接口引用:DescribeGroupResourceUsage

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

KafkaDeliveryConfig

投递kafka配置项

被如下接口引用:DescribeDeliveryConfig

名称 必选 允许NULL 类型 描述
ConfigId String 配置项id
示例值:
ConfigName String 配置名称
示例值:
CollectPath Array of String 采集路径
示例值:
KafkaVIp String kafka vip
示例值:
KafkaVPort String kafka vport
示例值:
Topic String kafka topic
示例值:
LineRule String 换行规则
示例值:
EnableAuth Bool 是否需要认证
示例值:
Username String 用户名
示例值:
Password String 密码
示例值:
KafkaInfos Array of DeliveryKafkaInfo 投递的topic和path
示例值:查看
EnableGlobalLineRule Bool 是否应用单行规则
示例值:
CustomRule String 自定义分行规则
示例值:
KafkaAddress String KafkaAddress
示例值:

BillingDeal

计费订单

被如下接口引用:DescribeBillingDealRecords

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

Filter

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

被如下接口引用:DescribeInstances、DescribeMicroservice

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

CircuitBreakerStrategy

熔断策略

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

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

ConfigTemplate

配置模板对象

被如下接口引用:DescribeConfigTemplate、DescribeConfigTemplates

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

GatewayInstance

网关实体(单元化后使用)

被如下接口引用:DescribeGatewayInstance、DescribeGatewayInstances、DescribeGatewayInstancesByMultiCloud

名称 必选 允许NULL 类型 描述
Id String 网关实体ID
示例值:
ServiceId String 微服务ID(ms-xxx)
示例值:
ServiceName String 微服务名
示例值:
NamespaceId String 命名空间ID
示例值:
NamespaceName String 命名空间名
示例值:
Type String 网关实例类型:单元化(unit)/非单元化网关(none)
示例值:
ConsulInstanceCount Int64 注册中心在线节点数
示例值:
MultiCloudStatus String 是否禁用绑定(超云)
示例值:
MultiCloudStatusMsg String 禁用提示信息(超云)
示例值:
RouteScope String 转发范围 LOCAL (同城) REMOTE (异地) LOCAL_REMOTE  (支持同城及异地)
示例值:

ZipkinBinaryAnnotation

调用链Span二进制注解

被如下接口引用:GetTraceSpans

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

ContainerInstanceResourceConfig

容器实例相关的参数配置

被如下接口引用:DescribeResourceConfig

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

AlarmInfo

拓扑服务告警信息

被如下接口引用:DescribeNamespaceAlarm

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

TsfPageBuildTask

构建任务列表对象

被如下接口引用:DescribeBuildTasks

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

InstanceMetrics

实例监控指标

被如下接口引用:DescribeInstanceMetrics

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

PagedResource

分页资源列表

被如下接口引用:DescribeResources

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

ApplicationConfig

应用配置信息

被如下接口引用:DescribeReleaseTemplate、ModifyReleaseTemplate

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

OverviewMsResult

概览页微服务信息

被如下接口引用:DescribeOverviweService

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

JvmMonitorData

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

被如下接口引用:DescribeJvmMonitor

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

TsfPageBillingLicense

BillingLicense 翻页对象

被如下接口引用:DescribeAllBillingLicenses

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

ReleaseTask

发布单任务信息

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

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

TraceSpanInfo

span查询的出参

被如下接口引用:SearchSpan

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

MetricDataSingleValue

单值指标

被如下接口引用:DescribeInvocationMetricDataPoint

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

ResourceOperationStatusResult

描述操作执行结果

被如下接口引用:InterruptResourceBatchOperation

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

GatewayConfig

TSF Envoy网关服务配置

被如下接口引用:DeployContainerGroup、DeployGroup、DescribeContainerGroupDeployInfo、DescribeGroup、DescribeGroups

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

TsfRecordCodeResult

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

被如下接口引用:DescribeRecordCodes

名称 必选 允许NULL 类型 描述
Operations Array of TypeCode 操作类型术语
示例值:查看
Modules Array of TypeCode 模块类型术语
示例值:查看

ApplicationForPage

分页的应用描述信息字段

被如下接口引用:DescribeApplication、DescribeApplications

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

KubeNamespacePage

容器原生部署的集群命名空间列表

被如下接口引用:DescribeContainerNamespaces、DescribeExtraKubeNamespaces

名称 必选 允许NULL 类型 描述
TotalCount Int64 TotalCount值
示例值:
Content Array of KubeNamespace Content值`
示例值:查看

TsfPageVmTask

虚拟机任务分页信息

被如下接口引用:DscribeTasks

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

PkgBind

描述程序包关联信息

被如下接口引用:DescribePkgs、ListPkg

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

ServiceConfig

服务配置

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

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

EventDetail

事件详情

被如下接口引用:DescribeEventDetail

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

MonitorGroup

部署组信息,用于云监控

被如下接口引用:DescribeCloudMonitorGroups

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

Microservice

微服务

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

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

TsfPageBusinessLogV2

业务日志列表

被如下接口引用:SearchBusinessLog、SearchRealtimeBusinessLog、SearchRealtimeStdoutLog、SearchSpanBusinessLog、SearchSurroundBusinessLog

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

RouteElementMappingService

路由要素转换服务

被如下接口引用:CreateAndReleaseUnitRouteConfig

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

AuthConditionV2

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

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

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

GroupsByScalableRuleIdList

GroupsByScalableRuleIdList

被如下接口引用:ListGroupsByScalableRuleId

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

UnitArchNamespace

单元化架构命名空间

被如下接口引用:DescribeArchConfig、DescribeArchUnitNamespaces

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

CircuitBreakerApi

熔断API规则

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

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

TsfPageRouteReleaseHistory

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

被如下接口引用:DescribeRouteReleaseHistory

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

MicroserviceCount

服务数量信息

被如下接口引用:DescribeNamespaceMicroserviceCount

名称 必选 允许NULL 类型 描述
MsCount Int64 总服务数
示例值:
MsVarianceCount Int64 总服务变化量
示例值:
NormalCount Int64 在线服务数
示例值:
NormalVarianceCount Int64 在线服务数变化量
示例值:
AbnormalCount Int64 异常服务数
示例值:
AbnormalVarianceCount Int64 异常服务数变化量
示例值:

ImageRepository

镜像仓库

被如下接口引用:DescribeImageRepository、ImageGetRepositoryList

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

ThreadDetailInfo

线程数据详情

被如下接口引用:DescribeThreadDetailList

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

Cluster

集群

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

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

Service

tsf-privilege模块,产品

被如下接口引用:DescribeServices

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

ConfigTemplateResult

配置模板列表

被如下接口引用:DescribeConfigTemplates

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

Condition

路由规则条件

被如下接口引用:CreateAndReleaseUnitRouteConfig

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

TsfApiListResponse

TsfApiListResponse

被如下接口引用:DescribeInterfaceList、DescribeMsApiList

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

ReleasePipelineTask

发布单流水任务

被如下接口引用:DescribeReleasePipelineTask

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

StdoutLogV2

标准输出日志

被如下接口引用:SearchRealtimeBusinessLog、SearchRealtimeStdoutLog、SearchStdoutLog

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

ZipkinAnnotation

调用链Span注解

被如下接口引用:GetTraceSpans

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

ContainerEvent

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

被如下接口引用:DescribeContainerEvents

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

GatewayPluginDefinition

微服务网关插件定义数据

被如下接口引用:DescribeGatewayPluginTypes

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

UploadInfo

上传包ID

被如下接口引用:UploadPkg

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

TsfPageConfig

TsfPage

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

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

TsfPageMsInstance

微服务实例的分页内容

被如下接口引用:DescribeMicroservice

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

KubeDeployment

容器轻量化Deployment

被如下接口引用:DescribeKubeDeployments

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

TsfPageMeshLog

mesh 日志列表

被如下接口引用:SearchMeshLog、SearchRealtimeBusinessLog、SearchRealtimeStdoutLog

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

Consumer

Consumer

被如下接口引用:CreateAndDownloadTemplate、CreateTemplate

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

MeshLog

mesh 组件日志

被如下接口引用:SearchMeshLog、SearchRealtimeBusinessLog、SearchRealtimeStdoutLog

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

ContainGroupResult

部署组列表(应用下钻)

被如下接口引用:DescribeContainerGroups、ListContainGroup

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

GatewayJwtPlugin

微服务网关JWT插件

被如下接口引用:DescribeGatewayJwtPlugin

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

ScalableRule

ScalableRule值

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

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

IndicatorCoord

监控指标坐标

被如下接口引用:DescribeInovcationIndicators

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

NativeThreadCountData

DescribeThreadDump 接口出参封装

被如下接口引用:DescribeThreadDump

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

Config

配置项

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

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

DockerForUse

Docker使用指引

被如下接口引用:DescribeDockerForUse、GetDockerForUse

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

NamespaceInfos

命名空间id+命名空间name

被如下接口引用:CreateView、DescribeViews

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

GatewayOAuthPlugin

GatewayOAuthPlugin

被如下接口引用:DescribeGatewayOAuthPlugin

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

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信息
示例值:

InvocationMetricScatterPlot

监控数据散点图

被如下接口引用:DescribeInvocationMetricScatterPlot

名称 必选 允许NULL 类型 描述
EndTime Int64 时间轴截止时间,GMT,精确到毫秒
示例值:
StartTime Int64 时间粒度
示例值:
Period Int64 时间轴开始时间,GMT,精确到毫秒
示例值:
DataPoints Array of MultiValueDataPoints 多值数据点集合
示例值:查看

Extension

扩展信息

被如下接口引用:CreateAndReleaseArchConfig

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

ClusterLimitResourceV2

集群limit资源

被如下接口引用:DescribeClusterLimitResource

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

VolumeClaimTemplateOption

动态PVC模版

被如下接口引用:DeployContainerGroup、DescribeContainerGroupDeployInfo

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

BatchGroup

批次部署组

被如下接口引用:DescribeReleaseTemplate、ModifyReleaseTemplate

名称 必选 允许NULL 类型 描述
Groups Array of ReleaseGroup 批次内的部署组列表
示例值:查看

RatelimitRuleForUpdate

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

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

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

SimpleApplication

简单应用

被如下接口引用:DescribeSimpleApplications

名称 必选 允许NULL 类型 描述
ApplicationId String 应用ID
示例值:
ApplicationName String 应用名称
示例值:
ApplicationType String 应用类型
示例值:
MicroserviceType String 应用微服务类型
示例值:
ApplicationDesc String ApplicationDesc
示例值:
ProgLang String ProgLang
示例值:
ApplicationResourceType String ApplicationResourceType
示例值:
CreateTime String CreateTime
示例值:
UpdateTime String UpdateTime
示例值:
ApigatewayServiceId String ApigatewayServiceId
示例值:
ApplicationRuntimeType String ApplicationRuntimeType
示例值:
ApplicationRemarkName String ApplicationRemarkName
示例值:

PolicyItem

tsf-privilege模块,策略项

被如下接口引用:CreatePolicyDocument

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

InstanceAdvancedSettings

容器导入实例高级设置

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

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

RouteV2

路由规则信息

被如下接口引用:DescribeRoute、DescribeRoutes

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

ZipkinEndpointV2

调用链Span端点信息

被如下接口引用:DescribeSpanDetail、GetTraceSpans、SearchSpan

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

KubeInjectConfig

容器轻量化配置

被如下接口引用:DescribeKubeInjectConfig

名称 必选 允许NULL 类型 描述
EnableByDefault Bool EnableByDefault值
示例值:
DefaultMicroserviceType String DefaultMicroserviceType值
示例值:
AgentCpuRequest String AgentCpuRequest值
示例值:
AgentCpuLimit String AgentCpuLimit值
示例值:
AgentMemRequest String AgentMemRequest值
示例值:
AgentMemLimit String AgentMemLimit值
示例值:

MetricSummary

网关监控指标总览

被如下接口引用:DescribeGatewayMonitorDetails

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

ProgramItem

tsf-privilege模块,数据项

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

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

InterfaceRequest

单条接口请求详情

被如下接口引用:DescribeInterfaceRequest

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

TaskInstance

TaskInstance

被如下接口引用:ListScalableTasks

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

ContainerGroupResourceConfig

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

被如下接口引用:DescribeResourceConfig

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

CosCredentials

cos临时帐号信息

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

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

MonitorStatisticsPolicyResult

MonitorStatisticsPolicyResult

被如下接口引用:ListMonitorStatisticsPolicy

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

SetUpKubeInjectResult

SetUpKubeInjectResult值

被如下接口引用:SetUpKubeInject

名称 必选 允许NULL 类型 描述
Success Bool success值
示例值:
Yaml String yaml
示例值:

ClusterV2

集群详情

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

名称 必选 允许NULL 类型 描述
ClusterId String 集群ID
示例值:
ClusterName String 集群名称
示例值:
ClusterDesc String 集群描述
示例值:
ClusterType String 集群类型
示例值:
VpcId String 集群所属私有网络ID
示例值:
ClusterStatus String 集群状态
示例值:
ClusterCIDR String 集群CIDR
示例值:
ClusterTotalCpu Float 集群总CPU,单位: 核
示例值:
ClusterTotalMem Float 集群总内存,单位: G
示例值:
ClusterUsedCpu Float 集群已使用CPU,单位: 核
示例值:
ClusterUsedMem Float 集群已使用内存,单位: G
示例值:
InstanceCount Int64 集群机器实例数量
示例值:
RunInstanceCount Int64 集群运行中的机器实例数量
示例值:
NormalInstanceCount Int64 集群正常状态的机器实例数量
示例值:
DeleteFlag Bool 删除标记:true:可以删除;false:不可删除
示例值:
CreateTime String 创建时间
示例值:
UpdateTime String 更新时间
示例值:
TsfRegionId String 集群所属TSF地域ID
示例值:
TsfRegionName String 集群所属TSF地域名称
示例值:
TsfZoneId String 集群所属TSF可用区ID
示例值:
TsfZoneName String 集群所属TSF可用区名称
示例值:
DeleteFlagReason String 集群不可删除的原因
示例值:
SubnetId String 集群所属私有网络子网ID
示例值:
ClusterLimitCpu String 集群剩余 cpu limit
示例值:
ClusterLimitMem String 集群剩余 memory limit
示例值:
RunServiceInstanceCount Int64 运行服务实例数
示例值:
OperationInfo OperationInfo 给前端的按钮控制信息
示例值:查看
ClusterVersion String 容器集群版本
示例值:
GroupCount Uint64 部署组总数
示例值:
RunGroupCount Uint64 运行中部署组数
示例值:
StopGroupCount Uint64 停止中部署组数
示例值:
AbnormalGroupCount Uint64 异常部署组数
示例值:
ClusterRemarkName String 集群备注名
示例值:
KuberneteApiServer String api地址
示例值:
KuberneteNativeType String K : kubeconfig, S : service account
示例值:
KuberneteNativeSecret String native secret
示例值:
ProgramIdList Array of String
示例值:
MaxClusterServiceNum Int64
示例值:
MaxNodePodNum Int64
示例值:
ProgramId String
示例值:
KubeAuthValid Bool
示例值:
Unbind Bool
示例值:
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
示例值:

EventCategoryResult

事件概览结果

被如下接口引用:DescribeEventCategoryName、DescribeOverviewEvent

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

BillingOperationRecord

计费操作记录

被如下接口引用:DescribeBillingOperationRecords

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

OverviewHostResourceUsage

TSF实例相关基本信息概览

被如下接口引用:DescribeHostResourceUsage

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

SimpleResult

是否成功;失败原因

被如下接口引用:TestKuberneteNativeConnection

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

InstanceEnrichedInfoPage

InstanceEnrichedInfo列表结构

被如下接口引用:DescribeInstances

名称 必选 允许NULL 类型 描述
TotalCount Uint64 总数量
示例值:
Content Array of InstanceEnrichedInfo 列表
示例值:查看