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
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
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
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
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
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
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
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
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
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
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
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
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
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
CosDownloadInfo
Cos下载所需信息
被如下接口引用:DescribeDownloadInfo、GetDownloadInfo
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Bucket | 是 | 是 | String | 桶名称 示例值: |
| Region | 是 | 是 | String | 地域 示例值: |
| Path | 是 | 是 | String | 路径 示例值: |
| Credentials | 是 | 是 | CosCredentials | 鉴权信息 示例值:查看 |
AppPkgInfo
应用的包信息
被如下接口引用:ListAppPkg
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ApplicationId | 是 | 是 | String | 应用ID 示例值: |
| PkgCount | 是 | 是 | Int64 | 应用下的程序包数量 示例值: |
TsfPageRecordV2
操作记录列表对象
被如下接口引用:DescribeRecords
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
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
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
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
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
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
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
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
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
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
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
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
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 | 列表 示例值:查看 |