有奖捉虫:云通信与企业服务文档专题,速来> HOT

AddInstanceResult

添加实例到集群的结果

被如下接口引用:AddClusterInstances。

名称 类型 描述
FailedInstanceIds Array of String 添加集群失败的节点列表
注意:此字段可能返回 null,表示取不到有效值。
SuccInstanceIds Array of String 添加集群成功的节点列表
注意:此字段可能返回 null,表示取不到有效值。
TimeoutInstanceIds Array of String 添加集群超时的节点列表
注意:此字段可能返回 null,表示取不到有效值。
FailedReasons Array of String 失败的节点的失败原因
注意:此字段可能返回 null,表示取不到有效值。

AdvanceSettings

高级选项设置

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

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

AgentProfile

部署javaagent的类型、版本信息

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

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

ApiDefinitionDescr

API 对象类型描述

被如下接口引用:DescribeApiDetail。

名称 类型 描述
Name String 对象名称
Properties Array of PropertyField 对象属性列表

ApiDetailInfo

API 明细

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

名称 类型 描述
ApiId String API ID
注意:此字段可能返回 null,表示取不到有效值。
NamespaceId String 命名空间ID
注意:此字段可能返回 null,表示取不到有效值。
NamespaceName String 命名空间名称
注意:此字段可能返回 null,表示取不到有效值。
MicroserviceId String 服务ID
注意:此字段可能返回 null,表示取不到有效值。
MicroserviceName String 服务名称
注意:此字段可能返回 null,表示取不到有效值。
Path String API 请求路径
注意:此字段可能返回 null,表示取不到有效值。
PathMapping String Api 映射路径
注意:此字段可能返回 null,表示取不到有效值。
Method String 请求方法
注意:此字段可能返回 null,表示取不到有效值。
GroupId String 所属分组ID
注意:此字段可能返回 null,表示取不到有效值。
UsableStatus String 是否禁用
注意:此字段可能返回 null,表示取不到有效值。
ReleaseStatus String 发布状态
注意:此字段可能返回 null,表示取不到有效值。
RateLimitStatus String 开启限流
注意:此字段可能返回 null,表示取不到有效值。
MockStatus String 是否开启mock
注意:此字段可能返回 null,表示取不到有效值。
CreatedTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
UpdatedTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。
ReleasedTime String 发布时间
注意:此字段可能返回 null,表示取不到有效值。
GroupName String 所属分组名称
注意:此字段可能返回 null,表示取不到有效值。
Timeout Integer API 超时,单位毫秒
注意:此字段可能返回 null,表示取不到有效值。
Host String Api所在服务host
注意:此字段可能返回 null,表示取不到有效值。
ApiType String API类型。 ms : 微服务API; external :外部服务Api
注意:此字段可能返回 null,表示取不到有效值。
Description String Api描述信息
注意:此字段可能返回 null,表示取不到有效值。
ApiMatchType String API路径匹配类型。normal:普通API;wildcard:通配API。
注意:此字段可能返回 null,表示取不到有效值。
RpcExt String RPC 额外信息
注意:此字段可能返回 null,表示取不到有效值。
GatewayDeployGroupId String 部署组id
注意:此字段可能返回 null,表示取不到有效值。
Md5 String md5
注意:此字段可能返回 null,表示取不到有效值。
RpcType String RPC 类型
注意:此字段可能返回 null,表示取不到有效值。

ApiDetailResponse

ApiDetailResponse描述

被如下接口引用:DescribeApiDetail。

名称 类型 描述
Request Array of ApiRequestDescr API 请求参数
Response Array of ApiResponseDescr API 响应参数
注意:此字段可能返回 null,表示取不到有效值。
Definitions Array of ApiDefinitionDescr API 复杂结构定义
RequestContentType String API 的 content type
注意:此字段可能返回 null,表示取不到有效值。
CanRun Boolean API 能否调试
注意:此字段可能返回 null,表示取不到有效值。
Status Integer API 状态 0:离线 1:在线,默认0
注意:此字段可能返回 null,表示取不到有效值。
Description String API 描述
注意:此字段可能返回 null,表示取不到有效值。

ApiGroupInfo

API分组信息

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

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

ApiInfo

微服务网关API信息

被如下接口引用:CreateGatewayApi。

名称 类型 必选 描述
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描述信息

ApiRateLimitRule

微服务网关API限流规则

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

名称 类型 描述
RuleId String rule Id
注意:此字段可能返回 null,表示取不到有效值。
ApiId String API ID
注意:此字段可能返回 null,表示取不到有效值。
RuleName String 限流名称
注意:此字段可能返回 null,表示取不到有效值。
MaxQps Integer 最大限流qps
注意:此字段可能返回 null,表示取不到有效值。
UsableStatus String 生效/禁用, enabled/disabled
注意:此字段可能返回 null,表示取不到有效值。
RuleContent String 规则内容
注意:此字段可能返回 null,表示取不到有效值。
TsfRuleId String Tsf Rule ID
注意:此字段可能返回 null,表示取不到有效值。
Description String 描述
注意:此字段可能返回 null,表示取不到有效值。
CreatedTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
UpdatedTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。

ApiRequestDescr

ApiRequestDescr

被如下接口引用:DescribeApiDetail。

名称 类型 描述
Name String 参数名称
Type String 参数类型
In String 参数位置
Description String 参数描述
Required Boolean 参数是否必须
DefaultValue String 参数的默认值
注意:此字段可能返回 null,表示取不到有效值。

ApiResponseDescr

API 响应的参数结构描述

被如下接口引用:DescribeApiDetail。

名称 类型 描述
Name String 参数描述
Type String 参数类型
Description String 参数描述

ApiUseStatisticsEntity

API 日统计数据点

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

名称 类型 描述
Name String 名称
Count String 次数
Ratio String 比率

ApiVersionArray

API版本数组

被如下接口引用:DescribeApiVersions。

名称 类型 描述
ApplicationId String App ID
注意:此字段可能返回 null,表示取不到有效值。
ApplicationName String App 名称
注意:此字段可能返回 null,表示取不到有效值。
PkgVersion String App 包版本
注意:此字段可能返回 null,表示取不到有效值。

ApplicationAttribute

应用列表其它字段

被如下接口引用:DescribeApplicationAttribute。

名称 类型 描述
InstanceCount Integer 总实例个数
注意:此字段可能返回 null,表示取不到有效值。
RunInstanceCount Integer 运行实例个数
注意:此字段可能返回 null,表示取不到有效值。
GroupCount Integer 应用下部署组个数
注意:此字段可能返回 null,表示取不到有效值。

ApplicationForPage

分页的应用描述信息字段

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

名称 类型 描述
ApplicationId String 应用ID
注意:此字段可能返回 null,表示取不到有效值。
ApplicationName String 应用名称
注意:此字段可能返回 null,表示取不到有效值。
ApplicationDesc String 应用描述
注意:此字段可能返回 null,表示取不到有效值。
ApplicationType String 应用类型
注意:此字段可能返回 null,表示取不到有效值。
MicroserviceType String 微服务类型
注意:此字段可能返回 null,表示取不到有效值。
ProgLang String 编程语言
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。
ApplicationResourceType String 应用资源类型
注意:此字段可能返回 null,表示取不到有效值。
ApplicationRuntimeType String 应用runtime类型
注意:此字段可能返回 null,表示取不到有效值。
ApigatewayServiceId String Apigateway的serviceId
注意:此字段可能返回 null,表示取不到有效值。
ApplicationRemarkName String 应用备注名
注意:此字段可能返回 null,表示取不到有效值。
ServiceConfigList Array of ServiceConfig 服务配置信息列表
注意:此字段可能返回 null,表示取不到有效值。
IgnoreCreateImageRepository Boolean IgnoreCreateImageRepository
注意:此字段可能返回 null,表示取不到有效值。

BusinessLogConfig

业务日志配置

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

名称 类型 必选 描述
ConfigId String 配置项ID
ConfigName String 配置项名称
ConfigPath String 配置项日志路径
注意:此字段可能返回 null,表示取不到有效值。
ConfigDesc String 配置项描述
注意:此字段可能返回 null,表示取不到有效值。
ConfigTags String 配置项标签
注意:此字段可能返回 null,表示取不到有效值。
ConfigPipeline String 配置项对应的ES管道
注意:此字段可能返回 null,表示取不到有效值。
ConfigCreateTime String 配置项创建时间
注意:此字段可能返回 null,表示取不到有效值。
ConfigUpdateTime String 配置项更新时间
注意:此字段可能返回 null,表示取不到有效值。
ConfigSchema BusinessLogConfigSchema 配置项解析规则
注意:此字段可能返回 null,表示取不到有效值。
ConfigAssociatedGroupList Array of BusinessLogConfigAssociatedGroup 配置项关联部署组
注意:此字段可能返回 null,表示取不到有效值。

BusinessLogConfigAssociatedGroup

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

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

名称 类型 必选 描述
GroupId String 部署组ID
注意:此字段可能返回 null,表示取不到有效值。
GroupName String 部署组名称
注意:此字段可能返回 null,表示取不到有效值。
ApplicationId String 部署组所属应用ID
注意:此字段可能返回 null,表示取不到有效值。
ApplicationName String 部署组所属应用名称
注意:此字段可能返回 null,表示取不到有效值。
ApplicationType String 部署组所属应用类型
注意:此字段可能返回 null,表示取不到有效值。
NamespaceId String 部署组所属命名空间ID
注意:此字段可能返回 null,表示取不到有效值。
NamespaceName String 部署组所属命名空间名称
注意:此字段可能返回 null,表示取不到有效值。
ClusterId String 部署组所属集群ID
注意:此字段可能返回 null,表示取不到有效值。
ClusterName String 部署组所属集群名称
注意:此字段可能返回 null,表示取不到有效值。
ClusterType String 部署组所属集群类型
注意:此字段可能返回 null,表示取不到有效值。
AssociatedTime String 部署组关联日志配置时间
注意:此字段可能返回 null,表示取不到有效值。

BusinessLogConfigSchema

业务日志配置解析规则

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

名称 类型 必选 描述
SchemaType Integer 解析规则类型
SchemaContent String 解析规则内容
注意:此字段可能返回 null,表示取不到有效值。
SchemaDateFormat String 解析规则时间格式
注意:此字段可能返回 null,表示取不到有效值。
SchemaMultilinePattern String 解析规则对应的多行匹配规则
注意:此字段可能返回 null,表示取不到有效值。
SchemaCreateTime String 解析规则创建时间
注意:此字段可能返回 null,表示取不到有效值。
SchemaPatternLayout String 用户填写的解析规则
注意:此字段可能返回 null,表示取不到有效值。

BusinessLogV2

业务日志

被如下接口引用:SearchBusinessLog。

名称 类型 描述
InstanceId String 实例ID
注意:此字段可能返回 null,表示取不到有效值。
Content String 日志内容
注意:此字段可能返回 null,表示取不到有效值。
Timestamp Integer 日志时间戳
注意:此字段可能返回 null,表示取不到有效值。
InstanceIp String 实例IP
注意:此字段可能返回 null,表示取不到有效值。
LogId String 日志ID
注意:此字段可能返回 null,表示取不到有效值。
GroupId String 部署组ID
注意:此字段可能返回 null,表示取不到有效值。

Cluster

集群

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

名称 类型 描述
ClusterId String 集群ID
注意:此字段可能返回 null,表示取不到有效值。
ClusterName String 集群名称
注意:此字段可能返回 null,表示取不到有效值。
ClusterDesc String 集群描述
注意:此字段可能返回 null,表示取不到有效值。
ClusterType String 集群类型
注意:此字段可能返回 null,表示取不到有效值。
VpcId String 集群所属私有网络ID
注意:此字段可能返回 null,表示取不到有效值。
ClusterStatus String 集群状态
注意:此字段可能返回 null,表示取不到有效值。
ClusterCIDR String 集群CIDR
注意:此字段可能返回 null,表示取不到有效值。
ClusterTotalCpu Float 集群总CPU,单位: 核
注意:此字段可能返回 null,表示取不到有效值。
ClusterTotalMem Float 集群总内存,单位: G
注意:此字段可能返回 null,表示取不到有效值。
ClusterUsedCpu Float 集群已使用CPU,单位: 核
注意:此字段可能返回 null,表示取不到有效值。
ClusterUsedMem Float 集群已使用内存,单位: G
注意:此字段可能返回 null,表示取不到有效值。
InstanceCount Integer 集群机器实例数量
注意:此字段可能返回 null,表示取不到有效值。
RunInstanceCount Integer 集群可用的机器实例数量
注意:此字段可能返回 null,表示取不到有效值。
NormalInstanceCount Integer 集群正常状态的机器实例数量
注意:此字段可能返回 null,表示取不到有效值。
DeleteFlag Boolean 删除标记:true:可以删除;false:不可删除
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。
TsfRegionId String 集群所属TSF地域ID
注意:此字段可能返回 null,表示取不到有效值。
TsfRegionName String 集群所属TSF地域名称
注意:此字段可能返回 null,表示取不到有效值。
TsfZoneId String 集群所属TSF可用区ID
注意:此字段可能返回 null,表示取不到有效值。
TsfZoneName String 集群所属TSF可用区名称
注意:此字段可能返回 null,表示取不到有效值。
DeleteFlagReason String 集群不可删除的原因
注意:此字段可能返回 null,表示取不到有效值。
ClusterLimitCpu Float 集群最大CPU限制,单位:核
注意:此字段可能返回 null,表示取不到有效值。
ClusterLimitMem Float 集群最大内存限制,单位:G
注意:此字段可能返回 null,表示取不到有效值。
RunServiceInstanceCount Integer 集群可用的服务实例数量
注意:此字段可能返回 null,表示取不到有效值。
SubnetId String 集群所属子网ID
注意:此字段可能返回 null,表示取不到有效值。
OperationInfo OperationInfo 返回给前端的控制信息
注意:此字段可能返回 null,表示取不到有效值。
ClusterVersion String 集群版本
注意:此字段可能返回 null,表示取不到有效值。

ClusterV2

集群详情

被如下接口引用:DescribeClusters。

名称 类型 描述
ClusterId String 集群ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ClusterName String 集群名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ClusterDesc String 集群描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ClusterType String 集群类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
VpcId String 集群所属私有网络ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ClusterStatus String 集群状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ClusterCIDR String 集群CIDR
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ClusterTotalCpu Float 集群总CPU,单位: 核
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ClusterTotalMem Float 集群总内存,单位: G
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ClusterUsedCpu Float 集群已使用CPU,单位: 核
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ClusterUsedMem Float 集群已使用内存,单位: G
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
InstanceCount Integer 集群机器实例数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RunInstanceCount Integer 集群运行中的机器实例数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
NormalInstanceCount Integer 集群正常状态的机器实例数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
DeleteFlag Boolean 删除标记:true:可以删除;false:不可删除
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
UpdateTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TsfRegionId String 集群所属TSF地域ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TsfRegionName String 集群所属TSF地域名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TsfZoneId String 集群所属TSF可用区ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TsfZoneName String 集群所属TSF可用区名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
DeleteFlagReason String 集群不可删除的原因
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SubnetId String 集群所属私有网络子网ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ClusterLimitCpu String 集群剩余 cpu limit
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ClusterLimitMem String 集群剩余 memory limit
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RunServiceInstanceCount Integer 运行服务实例数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
OperationInfo OperationInfo 给前端的按钮控制信息
注意:此字段可能返回 null,表示取不到有效值。
ClusterVersion String 容器集群版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
GroupCount Integer 部署组总数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RunGroupCount Integer 运行中部署组数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
StopGroupCount Integer 停止中部署组数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
AbnormalGroupCount Integer 异常部署组数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ClusterRemarkName String 集群备注名
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
KuberneteApiServer String api地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
KuberneteNativeType String K : kubeconfig, S : service account
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
KuberneteNativeSecret String native secret
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

Config

配置项

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

名称 类型 描述
ConfigId String 配置项ID
注意:此字段可能返回 null,表示取不到有效值。
ConfigName String 配置项名称
注意:此字段可能返回 null,表示取不到有效值。
ConfigVersion String 配置项版本
注意:此字段可能返回 null,表示取不到有效值。
ConfigVersionDesc String 配置项版本描述
注意:此字段可能返回 null,表示取不到有效值。
ConfigValue String 配置项值
注意:此字段可能返回 null,表示取不到有效值。
ConfigType String 配置项类型
注意:此字段可能返回 null,表示取不到有效值。
CreationTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
ApplicationId String 应用ID
注意:此字段可能返回 null,表示取不到有效值。
ApplicationName String 应用名称
注意:此字段可能返回 null,表示取不到有效值。
DeleteFlag Boolean 删除标识,true:可以删除;false:不可删除
注意:此字段可能返回 null,表示取不到有效值。
LastUpdateTime String 最后更新时间
注意:此字段可能返回 null,表示取不到有效值。
ConfigVersionCount Integer 配置项版本数量
注意:此字段可能返回 null,表示取不到有效值。

ConfigRelease

配置项发布信息

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

名称 类型 描述
ConfigReleaseId String 配置项发布ID
注意:此字段可能返回 null,表示取不到有效值。
ConfigId String 配置项ID
注意:此字段可能返回 null,表示取不到有效值。
ConfigName String 配置项名称
注意:此字段可能返回 null,表示取不到有效值。
ConfigVersion String 配置项版本
注意:此字段可能返回 null,表示取不到有效值。
ReleaseTime String 发布时间
注意:此字段可能返回 null,表示取不到有效值。
GroupId String 部署组ID
注意:此字段可能返回 null,表示取不到有效值。
GroupName String 部署组名称
注意:此字段可能返回 null,表示取不到有效值。
NamespaceId String 命名空间ID
注意:此字段可能返回 null,表示取不到有效值。
NamespaceName String 命名空间名称
注意:此字段可能返回 null,表示取不到有效值。
ClusterId String 集群ID
注意:此字段可能返回 null,表示取不到有效值。
ClusterName String 集群名称
注意:此字段可能返回 null,表示取不到有效值。
ReleaseDesc String 发布描述
注意:此字段可能返回 null,表示取不到有效值。
ApplicationId String 应用ID
注意:此字段可能返回 null,表示取不到有效值。
ConfigCenters Array of TsfConfigCenter 配置中心发布情况
注意:此字段可能返回 null,表示取不到有效值。

ConfigReleaseLog

配置项发布日志

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

名称 类型 描述
ConfigReleaseLogId String 配置项发布日志ID
注意:此字段可能返回 null,表示取不到有效值。
ConfigId String 配置项ID
注意:此字段可能返回 null,表示取不到有效值。
ConfigName String 配置项名称
注意:此字段可能返回 null,表示取不到有效值。
ConfigVersion String 配置项版本
注意:此字段可能返回 null,表示取不到有效值。
GroupId String 部署组ID
注意:此字段可能返回 null,表示取不到有效值。
GroupName String 部署组名称
注意:此字段可能返回 null,表示取不到有效值。
NamespaceId String 命名空间ID
注意:此字段可能返回 null,表示取不到有效值。
NamespaceName String 命名空间名称
注意:此字段可能返回 null,表示取不到有效值。
ClusterId String 集群ID
注意:此字段可能返回 null,表示取不到有效值。
ClusterName String 集群名称
注意:此字段可能返回 null,表示取不到有效值。
ReleaseTime String 发布时间
注意:此字段可能返回 null,表示取不到有效值。
ReleaseDesc String 发布描述
注意:此字段可能返回 null,表示取不到有效值。
ReleaseStatus String 发布状态
注意:此字段可能返回 null,表示取不到有效值。
LastConfigId String 上次发布的配置项ID
注意:此字段可能返回 null,表示取不到有效值。
LastConfigName String 上次发布的配置项名称
注意:此字段可能返回 null,表示取不到有效值。
LastConfigVersion String 上次发布的配置项版本
注意:此字段可能返回 null,表示取不到有效值。
RollbackFlag Boolean 回滚标识
注意:此字段可能返回 null,表示取不到有效值。
ReleasedConfigCenter String 发布成功的配置中心
ALL/EXCLUSIVE/SHARE/NONE

全部发布成功,独占发布成功,共享发布成功,全部发布失败
注意:此字段可能返回 null,表示取不到有效值。

ConfigTemplate

配置模板对象

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

名称 类型 必选 描述
ConfigTemplateId String 配置模板Id
注意:此字段可能返回 null,表示取不到有效值。
ConfigTemplateName String 配置模板名称
注意:此字段可能返回 null,表示取不到有效值。
ConfigTemplateDesc String 配置模板描述
注意:此字段可能返回 null,表示取不到有效值。
ConfigTemplateType String 配置模板对应的微服务框架
注意:此字段可能返回 null,表示取不到有效值。
ConfigTemplateValue String 配置模板数据
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。

ContainGroup

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

被如下接口引用:DescribeContainerGroups。

名称 类型 描述
GroupId String 部署组ID
注意:此字段可能返回 null,表示取不到有效值。
GroupName String 分组名称
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
Server String 镜像server
注意:此字段可能返回 null,表示取不到有效值。
RepoName String 镜像名,如/tsf/nginx
注意:此字段可能返回 null,表示取不到有效值。
TagName String 镜像版本名称
注意:此字段可能返回 null,表示取不到有效值。
ClusterId String 集群ID
注意:此字段可能返回 null,表示取不到有效值。
ClusterName String 集群名称
注意:此字段可能返回 null,表示取不到有效值。
NamespaceId String 命名空间ID
注意:此字段可能返回 null,表示取不到有效值。
NamespaceName String 命名空间名称
注意:此字段可能返回 null,表示取不到有效值。
CpuRequest String 初始分配的 CPU 核数,对应 K8S request
注意:此字段可能返回 null,表示取不到有效值。
CpuLimit String 最大分配的 CPU 核数,对应 K8S limit
注意:此字段可能返回 null,表示取不到有效值。
MemRequest String 初始分配的内存 MiB 数,对应 K8S request
注意:此字段可能返回 null,表示取不到有效值。
MemLimit String 最大分配的内存 MiB 数,对应 K8S limit
注意:此字段可能返回 null,表示取不到有效值。
Alias String 部署组备注
注意:此字段可能返回 null,表示取不到有效值。
KubeInjectEnable Boolean KubeInjectEnable值
注意:此字段可能返回 null,表示取不到有效值。
UpdatedTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。

ContainGroupResult

部署组列表(应用下钻)

被如下接口引用:DescribeContainerGroups。

名称 类型 描述
Content Array of ContainGroup 部署组列表
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 总记录数

ContainerEvent

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

被如下接口引用:DescribeContainerEvents。

名称 类型 描述
FirstTimestamp Integer 第一次出现的时间,以 ms 为单位的时间戳
注意:此字段可能返回 null,表示取不到有效值。
示例值:1615463411385
LastTimestamp Integer 最后一次出现的时间,以 ms 为单位的时间戳
注意:此字段可能返回 null,表示取不到有效值。
示例值:1615463411385
Type String 级别
注意:此字段可能返回 null,表示取不到有效值。
示例值:Warning
Kind String 资源类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:Pod
Name String 资源名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:shop-demo-7ff965d54d-65rlw.1668ccf6e4263fde
Reason String 内容
注意:此字段可能返回 null,表示取不到有效值。
示例值:Pulled
Message String 详细描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:0/1 nodes are available: 1 Insufficient memory.
Count Integer 出现次数
注意:此字段可能返回 null,表示取不到有效值。
示例值:3

ContainerGroupDeploy

获取部署组

被如下接口引用:DescribeContainerGroupDeployInfo。

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

ContainerGroupDetail

容器部署组详情

被如下接口引用:DescribeContainerGroupDetail。

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

ContainerGroupOther

部署组列表-其它字段

被如下接口引用:DescribeContainerGroupAttribute。

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

CosCredentials

cos临时账号信息

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

名称 类型 描述
SessionToken String 会话Token
注意:此字段可能返回 null,表示取不到有效值。
TmpAppId String 临时应用ID
注意:此字段可能返回 null,表示取不到有效值。
TmpSecretId String 临时调用者身份ID
注意:此字段可能返回 null,表示取不到有效值。
TmpSecretKey String 临时密钥
注意:此字段可能返回 null,表示取不到有效值。
ExpiredTime Integer 过期时间
注意:此字段可能返回 null,表示取不到有效值。
Domain String 所在域
注意:此字段可能返回 null,表示取不到有效值。

CosDownloadInfo

Cos下载所需信息

被如下接口引用:DescribeDownloadInfo。

名称 类型 描述
Bucket String 桶名称
注意:此字段可能返回 null,表示取不到有效值。
Region String 地域
注意:此字段可能返回 null,表示取不到有效值。
Path String 路径
注意:此字段可能返回 null,表示取不到有效值。
Credentials CosCredentials 鉴权信息
注意:此字段可能返回 null,表示取不到有效值。

CosUploadInfo

cos上传所需信息

被如下接口引用:DescribeUploadInfo。

名称 类型 描述
PkgId String 程序包ID
注意:此字段可能返回 null,表示取不到有效值。
Bucket String
注意:此字段可能返回 null,表示取不到有效值。
Region String 目标地域
注意:此字段可能返回 null,表示取不到有效值。
Path String 存储路径
注意:此字段可能返回 null,表示取不到有效值。
Credentials CosCredentials 鉴权信息

CurvePoint

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

被如下接口引用:DescribeJvmMonitor。

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

DeleteImageTag

需要删除的镜像版本

被如下接口引用:DeleteImageTags。

名称 类型 必选 描述
RepoName String 仓库名,如/tsf/nginx
TagName String 版本号:如V1

DeliveryConfigBindGroup

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

被如下接口引用:DescribeDeliveryConfigs。

名称 类型 必选 描述
ConfigId String 配置id
ConfigName String 配置名
CollectPath Array of String 采集路径
注意:此字段可能返回 null,表示取不到有效值。
Groups Array of GroupInfo 关联部署组信息
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
KafkaVIp String KafkaVIp
注意:此字段可能返回 null,表示取不到有效值。
KafkaAddress String KafkaAddress
注意:此字段可能返回 null,表示取不到有效值。
KafkaVPort String KafkaVPort
注意:此字段可能返回 null,表示取不到有效值。
Topic String Topic
注意:此字段可能返回 null,表示取不到有效值。
LineRule String LineRule
注意:此字段可能返回 null,表示取不到有效值。
CustomRule String CustomRule
注意:此字段可能返回 null,表示取不到有效值。
EnableGlobalLineRule Boolean EnableGlobalLineRule
注意:此字段可能返回 null,表示取不到有效值。
EnableAuth Boolean EnableAuth
注意:此字段可能返回 null,表示取不到有效值。
Username String Username
注意:此字段可能返回 null,表示取不到有效值。
Password String Password
注意:此字段可能返回 null,表示取不到有效值。
KafkaInfos Array of DeliveryKafkaInfo KafkaInfos
注意:此字段可能返回 null,表示取不到有效值。

DeliveryConfigBindGroups

描述配置项绑定的部署组

被如下接口引用:DescribeDeliveryConfigs。

名称 类型 描述
TotalCount Integer 公共条数
注意:此字段可能返回 null,表示取不到有效值。
Content Array of DeliveryConfigBindGroup 内容
注意:此字段可能返回 null,表示取不到有效值。

DeliveryKafkaInfo

kafka投递的topic和path的信息

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

名称 类型 必选 描述
Topic String 投递kafka的topic
注意:此字段可能返回 null,表示取不到有效值。
Path Array of String 采集日志的path
注意:此字段可能返回 null,表示取不到有效值。
LineRule String default,默认换行符分行
time,按时间分行
custom, 选了custom那么CustomRule就要填入具体的自定义值
注意:此字段可能返回 null,表示取不到有效值。
CustomRule String 自定义的分行值
注意:此字段可能返回 null,表示取不到有效值。

Env

环境变量

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

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

FieldRef

容器 env 的 FieldRef

被如下接口引用:DeployContainerGroup, DescribeContainerGroupDeployInfo。

名称 类型 必选 描述
FieldPath String k8s 的 FieldPath
注意:此字段可能返回 null,表示取不到有效值。
示例值:metadata.name

FileConfig

文件配置项

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

名称 类型 必选 描述
ConfigId String 配置项ID
注意:此字段可能返回 null,表示取不到有效值。
ConfigName String 配置项名称
注意:此字段可能返回 null,表示取不到有效值。
ConfigVersion String 配置项版本
注意:此字段可能返回 null,表示取不到有效值。
ConfigVersionDesc String 配置项版本描述
注意:此字段可能返回 null,表示取不到有效值。
ConfigFileName String 配置项文件名
注意:此字段可能返回 null,表示取不到有效值。
ConfigFileValue String 配置项文件内容
注意:此字段可能返回 null,表示取不到有效值。
ConfigFileCode String 配置项文件编码
注意:此字段可能返回 null,表示取不到有效值。
CreationTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
ApplicationId String 配置项归属应用ID
注意:此字段可能返回 null,表示取不到有效值。
ApplicationName String 应用名称
注意:此字段可能返回 null,表示取不到有效值。
DeleteFlag Boolean 删除标识
注意:此字段可能返回 null,表示取不到有效值。
ConfigVersionCount Integer 配置项版本数量
注意:此字段可能返回 null,表示取不到有效值。
LastUpdateTime String 配置项最后更新时间
注意:此字段可能返回 null,表示取不到有效值。
ConfigFilePath String 发布路径
注意:此字段可能返回 null,表示取不到有效值。
ConfigPostCmd String 后置命令
注意:此字段可能返回 null,表示取不到有效值。
ConfigFileValueLength Integer 配置项文件长度
注意:此字段可能返回 null,表示取不到有效值。

FileConfigRelease

文件配置项发布信息

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

名称 类型 描述
ConfigReleaseId String 配置项发布ID
注意:此字段可能返回 null,表示取不到有效值。
ConfigId String 配置项ID
注意:此字段可能返回 null,表示取不到有效值。
ConfigName String 配置项名称
注意:此字段可能返回 null,表示取不到有效值。
ConfigVersion String 配置项版本
注意:此字段可能返回 null,表示取不到有效值。
ReleaseDesc String 发布描述
注意:此字段可能返回 null,表示取不到有效值。
ReleaseTime String 发布时间
注意:此字段可能返回 null,表示取不到有效值。
GroupId String 部署组ID
注意:此字段可能返回 null,表示取不到有效值。
GroupName String 部署组名称
注意:此字段可能返回 null,表示取不到有效值。
NamespaceId String 命名空间ID
注意:此字段可能返回 null,表示取不到有效值。
NamespaceName String 命名空间名称
注意:此字段可能返回 null,表示取不到有效值。
ClusterId String 集群ID
注意:此字段可能返回 null,表示取不到有效值。
ClusterName String 集群名称
注意:此字段可能返回 null,表示取不到有效值。

Filter

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

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

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

GatewayApiGroupVo

网关分组简单信息

被如下接口引用:DescribeGatewayAllGroupApis。

名称 类型 描述
GroupId String 分组ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:grp-vcgimq3x
GroupName String 分组名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:testGroup1
GroupApiCount Integer 分组下API个数
注意:此字段可能返回 null,表示取不到有效值。
示例值:22
GroupApis Array of GatewayGroupApiVo 分组API列表
注意:此字段可能返回 null,表示取不到有效值。
GatewayInstanceType String 网关实例的类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:unit
GatewayInstanceId String 网关实例ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:gw-ins-4hkjbwxy

GatewayConfig

TSF Envoy网关服务配置

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

名称 类型 必选 描述

GatewayDeployGroup

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

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

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

GatewayGroupApiVo

网关API简单信息

被如下接口引用:DescribeGatewayAllGroupApis。

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

GatewayGroupIds

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

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

名称 类型 必选 描述
GatewayDeployGroupId String 网关部署组ID
GroupId String 分组id

GatewayPlugin

微服务网关插件实例对象

被如下接口引用:DescribePluginInstances。

名称 类型 描述
Id String 网关插件id
注意:此字段可能返回 null,表示取不到有效值。
Name String 插件名称
注意:此字段可能返回 null,表示取不到有效值。
Type String 插件类型
注意:此字段可能返回 null,表示取不到有效值。
Description String 插件描述
注意:此字段可能返回 null,表示取不到有效值。
CreatedTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
UpdatedTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。
Status String 发布状态
注意:此字段可能返回 null,表示取不到有效值。

GatewayPluginBoundParam

微服务网关插件绑定对象

被如下接口引用:BindPlugin。

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

GatewayVo

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

被如下接口引用:DescribeGatewayAllGroupApis。

名称 类型 描述
GatewayDeployGroupId String 网关部署组ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:gw-e42d597
GatewayDeployGroupName String 网关部署组名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:scg-container-test
GroupNum Integer API 分组个数
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
Groups Array of GatewayApiGroupVo API 分组列表
注意:此字段可能返回 null,表示取不到有效值。

GroupApiUseStatistics

API监控明细数据

被如下接口引用:DescribeApiUseDetail。

名称 类型 描述
TopStatusCode Array of ApiUseStatisticsEntity 总调用数
注意:此字段可能返回 null,表示取不到有效值。
TopTimeCost Array of ApiUseStatisticsEntity 平均错误率
注意:此字段可能返回 null,表示取不到有效值。
Quantile QuantileEntity 分位值对象
注意:此字段可能返回 null,表示取不到有效值。

GroupContainerInfo

部署组容器信息

被如下接口引用:DescribeContainerGroupDeployInfo。

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

GroupDailyUseStatistics

分组日使用统计对象

被如下接口引用:DescribeGroupUseDetail。

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

GroupInfo

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

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

名称 类型 必选 描述
GroupId String 部署组id
GroupName String 部署组名称
ClusterType String 集群类型
ClusterId String 集群id
注意:此字段可能返回 null,表示取不到有效值。
ClusterName String 集群名称
注意:此字段可能返回 null,表示取不到有效值。
NamespaceName String 命名空间名称
注意:此字段可能返回 null,表示取不到有效值。
AssociateTime String 绑定时间
注意:此字段可能返回 null,表示取不到有效值。

GroupPod

部署组实例列表

被如下接口引用:DescribePodInstances。

名称 类型 描述
PodName String 实例名称(对应到kubernetes的pod名称)
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx
PodId String 实例ID(对应到kubernetes的pod id)
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx
Status String 实例状态,请参考后面的实例以及容器的状态定义。启动中(pod 未 ready):Starting;运行中:Running;异常:Abnormal;停止:Stopped;
注意:此字段可能返回 null,表示取不到有效值。
示例值:Running
Reason String 实例处于当前状态的原因,例如容器下载镜像失败
注意:此字段可能返回 null,表示取不到有效值。
示例值:null
NodeIp String 主机IP
注意:此字段可能返回 null,表示取不到有效值。
示例值:10.10.0.1
Ip String 实例IP
注意:此字段可能返回 null,表示取不到有效值。
示例值:10.10.0.2
RestartCount Integer 实例中容器的重启次数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ReadyCount Integer 实例中已就绪容器的个数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Runtime String 运行时长
注意:此字段可能返回 null,表示取不到有效值。
示例值:null
CreatedAt String 实例启动时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:null
ServiceInstanceStatus String 服务实例状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:null
InstanceAvailableStatus String 机器实例可使用状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:null
InstanceStatus String 机器实例状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:null
NodeInstanceId String 节点实例id
注意:此字段可能返回 null,表示取不到有效值。
示例值:null

GroupPodResult

部署组实例列表

被如下接口引用:DescribePodInstances。

名称 类型 描述
TotalCount Integer 总记录数
注意:此字段可能返回 null,表示取不到有效值。
Content Array of GroupPod 列表信息
注意:此字段可能返回 null,表示取不到有效值。

GroupRelease

部署组配置发布相关信息

被如下接口引用:DescribeGroupRelease。

名称 类型 描述
PackageId String 程序包ID
注意:此字段可能返回 null,表示取不到有效值。
PackageName String 程序包名
注意:此字段可能返回 null,表示取不到有效值。
PackageVersion String 程序包版本
注意:此字段可能返回 null,表示取不到有效值。
RepoName String 镜像名
注意:此字段可能返回 null,表示取不到有效值。
TagName String 镜像版本
注意:此字段可能返回 null,表示取不到有效值。
PublicConfigReleaseList Array of ConfigRelease 已发布的全局配置列表
注意:此字段可能返回 null,表示取不到有效值。
ConfigReleaseList Array of ConfigRelease 已发布的应用配置列表
注意:此字段可能返回 null,表示取不到有效值。
FileConfigReleaseList Array of FileConfigRelease 已发布的文件配置列表
注意:此字段可能返回 null,表示取不到有效值。

GroupUnitApiDailyUseStatistics

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

被如下接口引用:DescribeUnitApiUseDetail。

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

GroupUnitApiUseStatistics

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

被如下接口引用:DescribeUnitApiUseDetail。

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

GroupUseStatisticsEntity

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

被如下接口引用:DescribeGroupUseDetail。

名称 类型 描述
ApiPath String API 路径
注意:此字段可能返回 null,表示取不到有效值。
ServiceName String 服务名
注意:此字段可能返回 null,表示取不到有效值。
Value String 统计值
注意:此字段可能返回 null,表示取不到有效值。
ApiId String API ID
注意:此字段可能返回 null,表示取不到有效值。

HealthCheckConfig

健康检查配置

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

名称 类型 必选 描述
Path String 健康检查路径
注意:此字段可能返回 null,表示取不到有效值。

HealthCheckSetting

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

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

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

HealthCheckSettings

健康检查参数

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

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

ImageRepository

镜像仓库

被如下接口引用:DescribeImageRepository。

名称 类型 描述
Reponame String 仓库名,含命名空间,如tsf/nginx
注意:此字段可能返回 null,表示取不到有效值。
Repotype String 仓库类型
注意:此字段可能返回 null,表示取不到有效值。
TagCount Integer 镜像版本数
注意:此字段可能返回 null,表示取不到有效值。
IsPublic Integer 是否公共,1:公有,0:私有
注意:此字段可能返回 null,表示取不到有效值。
IsUserFavor Boolean 是否被用户收藏。true:是,false:否
注意:此字段可能返回 null,表示取不到有效值。
IsQcloudOfficial Boolean 是否是腾讯云官方仓库。 是否是腾讯云官方仓库。true:是,false:否
注意:此字段可能返回 null,表示取不到有效值。
FavorCount Integer 被所有用户收藏次数
注意:此字段可能返回 null,表示取不到有效值。
PullCount Integer 拉取次数
注意:此字段可能返回 null,表示取不到有效值。
Description String 描述内容
注意:此字段可能返回 null,表示取不到有效值。
CreationTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。
TcrRepoInfo TcrRepoInfo TcrRepoInfo值
注意:此字段可能返回 null,表示取不到有效值。
TcrBindingId Integer TcrBindingId值
注意:此字段可能返回 null,表示取不到有效值。
ApplicationId String applicationid值
注意:此字段可能返回 null,表示取不到有效值。
ApplicationName ScalableRule ApplicationName值(废弃)
注意:此字段可能返回 null,表示取不到有效值。
ApplicationNameReal String ApplicationName值
注意:此字段可能返回 null,表示取不到有效值。
Public Integer 是否公共,1:公有,0:私有
注意:此字段可能返回 null,表示取不到有效值。

ImageRepositoryResult

镜像仓库列表

被如下接口引用:DescribeImageRepository。

名称 类型 描述
TotalCount Integer 总记录数
注意:此字段可能返回 null,表示取不到有效值。
Server String 镜像服务器地址
注意:此字段可能返回 null,表示取不到有效值。
Content Array of ImageRepository 列表信息
注意:此字段可能返回 null,表示取不到有效值。

ImageTag

列表信息

被如下接口引用:DescribeImageTags。

名称 类型 描述
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 操作系统
注意:此字段可能返回 null,表示取不到有效值。
PushTime String push时间
SizeByte Integer 单位为字节
TcrRepoInfo TcrRepoInfo TcrRepoInfo值
注意:此字段可能返回 null,表示取不到有效值。

ImageTagsResult

镜像版本列表

被如下接口引用:DescribeImageTags。

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

IndicatorCoord

监控指标坐标

被如下接口引用:DescribeInovcationIndicators。

名称 类型 描述
CoordX String 指标横坐标值
注意:此字段可能返回 null,表示取不到有效值。
CoordY String 指标纵坐标值
注意:此字段可能返回 null,表示取不到有效值。
CoordTag String 指标标签,用于标识附加信息
注意:此字段可能返回 null,表示取不到有效值。

Instance

机器实例

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

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

InstanceAdvancedSettings

容器导入实例高级设置

被如下接口引用:AddClusterInstances。

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

InstanceEnrichedInfo

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

被如下接口引用:DescribeInstances。

名称 类型 描述
InstanceId String 机器ID
注意:此字段可能返回 null,表示取不到有效值。
InstanceName String 机器名称
注意:此字段可能返回 null,表示取不到有效值。
LanIp String 机器内网IP
注意:此字段可能返回 null,表示取不到有效值。
WanIp String 机器外网IP
注意:此字段可能返回 null,表示取不到有效值。
VpcId String 机器所在VPC
注意:此字段可能返回 null,表示取不到有效值。
InstanceStatus String 机器运行状态 Pending Running Stopped Rebooting Starting Stopping Abnormal Unknown
注意:此字段可能返回 null,表示取不到有效值。
InstanceAvailableStatus String 机器可用状态(表示机器上的Agent在线)
注意:此字段可能返回 null,表示取不到有效值。
ApplicationId String 应用ID
注意:此字段可能返回 null,表示取不到有效值。
ApplicationName String 应用名称
注意:此字段可能返回 null,表示取不到有效值。
ApplicationType String 应用类型
注意:此字段可能返回 null,表示取不到有效值。
ClusterId String 集群ID
注意:此字段可能返回 null,表示取不到有效值。
ClusterName String 集群名称
注意:此字段可能返回 null,表示取不到有效值。
ClusterType String 集群类型
注意:此字段可能返回 null,表示取不到有效值。
NamespaceId String 命名空间ID
注意:此字段可能返回 null,表示取不到有效值。
NamespaceName String 命名空间名称
注意:此字段可能返回 null,表示取不到有效值。
GroupId String 机器所在部署组ID
注意:此字段可能返回 null,表示取不到有效值。
GroupName String 部署组名称
注意:此字段可能返回 null,表示取不到有效值。

InstanceEnrichedInfoPage

InstanceEnrichedInfo列表结构

被如下接口引用:DescribeInstances。

名称 类型 描述
TotalCount Integer 总数量
注意:此字段可能返回 null,表示取不到有效值。
Content Array of InstanceEnrichedInfo 列表
注意:此字段可能返回 null,表示取不到有效值。

InvocationIndicator

服务调用监控指标

被如下接口引用:DescribeInovcationIndicators。

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

InvocationMetricScatterPlot

监控数据散点图

被如下接口引用:DescribeInvocationMetricScatterPlot。

名称 类型 描述
EndTime Integer 时间轴截止时间,GMT,精确到毫秒
示例值:1616656231170
StartTime Integer 时间粒度
示例值:60
Period Integer 时间轴开始时间,GMT,精确到毫秒
示例值:1616656231170
DataPoints Array of MultiValueDataPoints 多值数据点集合
注意:此字段可能返回 null,表示取不到有效值。
示例值:“”

JvmMonitorData

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

被如下接口引用:DescribeJvmMonitor。

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

KafkaDeliveryConfig

投递kafka配置项

被如下接口引用:DescribeDeliveryConfig。

名称 类型 描述
ConfigId String 配置项id
注意:此字段可能返回 null,表示取不到有效值。
ConfigName String 配置名称
注意:此字段可能返回 null,表示取不到有效值。
CollectPath Array of String 采集路径
注意:此字段可能返回 null,表示取不到有效值。
KafkaVIp String kafka vip
注意:此字段可能返回 null,表示取不到有效值。
KafkaVPort String kafka vport
注意:此字段可能返回 null,表示取不到有效值。
Topic String kafka topic
注意:此字段可能返回 null,表示取不到有效值。
LineRule String 换行规则
注意:此字段可能返回 null,表示取不到有效值。
EnableAuth Boolean 是否需要认证
注意:此字段可能返回 null,表示取不到有效值。
Username String 用户名
注意:此字段可能返回 null,表示取不到有效值。
Password String 密码
注意:此字段可能返回 null,表示取不到有效值。
KafkaInfos Array of DeliveryKafkaInfo 投递的topic和path
注意:此字段可能返回 null,表示取不到有效值。
EnableGlobalLineRule Boolean 是否应用单行规则
注意:此字段可能返回 null,表示取不到有效值。
CustomRule String 自定义分行规则
注意:此字段可能返回 null,表示取不到有效值。
KafkaAddress String KafkaAddress
注意:此字段可能返回 null,表示取不到有效值。

LaneGroup

泳道部署组

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

名称 类型 必选 描述
GroupId String 部署组ID
注意:此字段可能返回 null,表示取不到有效值。
Entrance Boolean 是否入口应用
注意:此字段可能返回 null,表示取不到有效值。
LaneGroupId String 泳道部署组ID
注意:此字段可能返回 null,表示取不到有效值。
LaneId String 泳道ID
注意:此字段可能返回 null,表示取不到有效值。
GroupName String 部署组名
注意:此字段可能返回 null,表示取不到有效值。
ApplicationId String 应用ID
注意:此字段可能返回 null,表示取不到有效值。
ApplicationName String 应用名
注意:此字段可能返回 null,表示取不到有效值。
NamespaceId String 命名空间ID
注意:此字段可能返回 null,表示取不到有效值。
NamespaceName String 命名空间名称
注意:此字段可能返回 null,表示取不到有效值。
CreateTime Integer 创建时间
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime Integer 更新时间
注意:此字段可能返回 null,表示取不到有效值。
ClusterType String 集群类型
注意:此字段可能返回 null,表示取不到有效值。

LaneInfo

泳道

被如下接口引用:DescribeLanes。

名称 类型 必选 描述
LaneId String 泳道ID
注意:此字段可能返回 null,表示取不到有效值。
LaneName String 泳道名称
注意:此字段可能返回 null,表示取不到有效值。
Remark String 泳道备注
注意:此字段可能返回 null,表示取不到有效值。
CreateTime Integer 创建时间
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime Integer 更新时间
注意:此字段可能返回 null,表示取不到有效值。
LaneGroupList Array of LaneGroup 泳道部署组
注意:此字段可能返回 null,表示取不到有效值。
Entrance Boolean 是否入口应用
注意:此字段可能返回 null,表示取不到有效值。
NamespaceIdList Array of String 泳道已经关联部署组的命名空间列表
注意:此字段可能返回 null,表示取不到有效值。
LaneGroupId String 泳道部署组ID
注意:此字段可能返回 null,表示取不到有效值。

LaneInfos

泳道分页查询

被如下接口引用:DescribeLanes。

名称 类型 描述
TotalCount Integer 总数
注意:此字段可能返回 null,表示取不到有效值。
Content Array of LaneInfo 泳道信息列表
注意:此字段可能返回 null,表示取不到有效值。

LaneRule

泳道规则

被如下接口引用:DescribeLaneRules。

名称 类型 描述
RuleId String 泳道规则ID
注意:此字段可能返回 null,表示取不到有效值。
RuleName String 泳道规则名称
注意:此字段可能返回 null,表示取不到有效值。
Priority Integer 优先级
注意:此字段可能返回 null,表示取不到有效值。
Remark String 备注
注意:此字段可能返回 null,表示取不到有效值。
RuleTagList Array of LaneRuleTag 泳道规则标签列表
注意:此字段可能返回 null,表示取不到有效值。
RuleTagRelationship String 泳道规则标签关系
注意:此字段可能返回 null,表示取不到有效值。
LaneId String 泳道ID
注意:此字段可能返回 null,表示取不到有效值。
Enable Boolean 开启状态
注意:此字段可能返回 null,表示取不到有效值。
CreateTime Integer 创建时间
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime Integer 更新时间
注意:此字段可能返回 null,表示取不到有效值。

LaneRuleTag

泳道规则标签

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

名称 类型 必选 描述
TagId String 标签ID
注意:此字段可能返回 null,表示取不到有效值。
TagName String 标签名
注意:此字段可能返回 null,表示取不到有效值。
TagOperator String 标签操作符
注意:此字段可能返回 null,表示取不到有效值。
TagValue String 标签值
注意:此字段可能返回 null,表示取不到有效值。
LaneRuleId String 泳道规则ID
注意:此字段可能返回 null,表示取不到有效值。
CreateTime Integer 创建时间
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime Integer 更新时间
注意:此字段可能返回 null,表示取不到有效值。

LaneRules

泳道规则分页查询

被如下接口引用:DescribeLaneRules。

名称 类型 描述
TotalCount Integer 总数
Content Array of LaneRule 泳道规则列表

MemoryPicture

Jvm监控内存数据封装

被如下接口引用:DescribeJvmMonitor。

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

Metric

指标

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

名称 类型 必选 描述
Name String 指标名称
注意:此字段可能返回 null,表示取不到有效值。
Function String 指标计算方式
注意:此字段可能返回 null,表示取不到有效值。

MetricDataCurve

指标监控数据曲线

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

名称 类型 描述
MetricName String 指标名称
注意:此字段可能返回 null,表示取不到有效值。
MetricFunction String 指标计算方式
注意:此字段可能返回 null,表示取不到有效值。
MetricDataPoints Array of MetricDataPoint 指标数据点集合
注意:此字段可能返回 null,表示取不到有效值。

MetricDataPoint

监控统计数据点

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

名称 类型 描述
Key String 数据点键
注意:此字段可能返回 null,表示取不到有效值。
Value String 数据点值
注意:此字段可能返回 null,表示取不到有效值。
Tag String 数据点标签
注意:此字段可能返回 null,表示取不到有效值。

MetricDataPointMap

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

被如下接口引用:DescribeUnitApiUseDetail。

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

MetricDataSingleValue

单值指标

被如下接口引用:DescribeInvocationMetricDataPoint。

名称 类型 描述
MetricName String 指标
注意:此字段可能返回 null,表示取不到有效值。
示例值:reqCount
MetricFunction String 统计方式
注意:此字段可能返回 null,表示取不到有效值。
示例值:sum
MetricDataValue String 指标值
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
DailyPercent Float 日环比
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

MetricDimension

指标维度

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

名称 类型 必选 描述
Name String 指标维度名称
注意:此字段可能返回 null,表示取不到有效值。
Value String 指标维度取值
注意:此字段可能返回 null,表示取不到有效值。

MetricDimensionValue

指标维度多值匹配

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

名称 类型 必选 描述
Name String 维度名
示例值:NamespaceId
Value Array of String 维度值
示例值:["a"]

Microservice

微服务

被如下接口引用:DescribeMicroservices。

名称 类型 必选 描述
MicroserviceId String 微服务ID
注意:此字段可能返回 null,表示取不到有效值。
MicroserviceName String 微服务名称
注意:此字段可能返回 null,表示取不到有效值。
MicroserviceDesc String 微服务描述
注意:此字段可能返回 null,表示取不到有效值。
CreateTime Integer 创建时间
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime Integer 更新时间
注意:此字段可能返回 null,表示取不到有效值。
NamespaceId String 命名空间ID
注意:此字段可能返回 null,表示取不到有效值。
RunInstanceCount Integer 微服务的运行实例数目
注意:此字段可能返回 null,表示取不到有效值。
CriticalInstanceCount Integer 微服务的离线实例数目
注意:此字段可能返回 null,表示取不到有效值。

MonitorOverview

监控概览对象

被如下接口引用:DescribeGatewayMonitorOverview。

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

MsApiArray

微服务API数组

被如下接口引用:DescribeMsApiList。

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

MsInstance

微服务实例信息

被如下接口引用:DescribeMicroservice。

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

MultiValue

多值数据

被如下接口引用:DescribeInvocationMetricScatterPlot。

名称 类型 描述
Values Array of Float 数据点
注意:此字段可能返回 null,表示取不到有效值。
示例值:[1,2,3]

MultiValueDataPoints

多值数据点集合

被如下接口引用:DescribeInvocationMetricScatterPlot。

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

Namespace

命名空间

被如下接口引用:DescribeSimpleNamespaces。

名称 类型 描述
NamespaceId String 命名空间ID
注意:此字段可能返回 null,表示取不到有效值。
NamespaceCode String 命名空间编码
注意:此字段可能返回 null,表示取不到有效值。
NamespaceName String 命名空间名称
注意:此字段可能返回 null,表示取不到有效值。
NamespaceDesc String 命名空间描述
注意:此字段可能返回 null,表示取不到有效值。
IsDefault String 默认命名空间
注意:此字段可能返回 null,表示取不到有效值。
NamespaceStatus String 命名空间状态
注意:此字段可能返回 null,表示取不到有效值。
DeleteFlag Boolean 删除标识
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。
ClusterList Array of Cluster 集群数组,仅携带集群ID,集群名称,集群类型等基础信息。
注意:此字段可能返回 null,表示取不到有效值。
ClusterId String 集群ID
注意:此字段可能返回 null,表示取不到有效值。
NamespaceResourceType String 集群资源类型
注意:此字段可能返回 null,表示取不到有效值。
NamespaceType String 命名空间类型
注意:此字段可能返回 null,表示取不到有效值。
IsHaEnable String 是否开启高可用
注意:此字段可能返回 null,表示取不到有效值。
KubeInjectEnable Boolean KubeInjectEnable值
注意:此字段可能返回 null,表示取不到有效值。

OperationInfo

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

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

名称 类型 描述
Init OperationInfoDetail 初始化按钮的控制信息
注意:此字段可能返回 null,表示取不到有效值。
AddInstance OperationInfoDetail 添加实例按钮的控制信息
注意:此字段可能返回 null,表示取不到有效值。
Destroy OperationInfoDetail 销毁机器的控制信息
注意:此字段可能返回 null,表示取不到有效值。

OperationInfoDetail

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

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

名称 类型 描述
DisabledReason String 不显示的原因
注意:此字段可能返回 null,表示取不到有效值。
Enabled Boolean 该按钮是否可点击
注意:此字段可能返回 null,表示取不到有效值。
Supported Boolean 是否显示该按钮
注意:此字段可能返回 null,表示取不到有效值。

OverviewBasicResourceUsage

TSF基本资源信息概览

被如下接口引用:DescribeBasicResourceUsage。

名称 类型 描述
ApplicationCount Integer 应用总数
注意:此字段可能返回 null,表示取不到有效值。
NamespaceCount Integer 命名空间总数
注意:此字段可能返回 null,表示取不到有效值。
GroupCount Integer 部署组个数
注意:此字段可能返回 null,表示取不到有效值。
PackageSpaceUsed Integer 程序包存储空间用量,单位字节
注意:此字段可能返回 null,表示取不到有效值。
ConsulInstanceCount Integer 已注册实例数
注意:此字段可能返回 null,表示取不到有效值。

PagedProgram

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

被如下接口引用:DescribePrograms。

名称 类型 描述
TotalCount Integer 总条数
Content Array of Program 数据集列表

PathRewrite

路径重写

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

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

PathRewriteCreateObject

路径重写创建对象

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

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

PathRewritePage

路径重写翻页对象

被如下接口引用:DescribePathRewrites。

名称 类型 描述
TotalCount Integer 总记录数
Content Array of PathRewrite 路径重写规则列表

PkgBind

描述程序包关联信息

被如下接口引用:DescribePkgs。

名称 类型 描述
ApplicationId String 应用id
注意:此字段可能返回 null,表示取不到有效值。
GroupId String 部署组id
注意:此字段可能返回 null,表示取不到有效值。

PkgInfo

包信息

被如下接口引用:DescribePkgs。

名称 类型 描述
PkgId String 程序包ID
注意:此字段可能返回 null,表示取不到有效值。
PkgName String 程序包名
注意:此字段可能返回 null,表示取不到有效值。
PkgType String 程序包类型
注意:此字段可能返回 null,表示取不到有效值。
PkgVersion String 程序包版本
注意:此字段可能返回 null,表示取不到有效值。
PkgDesc String 程序包描述
注意:此字段可能返回 null,表示取不到有效值。
UploadTime String 上传时间
注意:此字段可能返回 null,表示取不到有效值。
Md5 String 程序包MD5
注意:此字段可能返回 null,表示取不到有效值。
PkgPubStatus Integer 程序包状态
注意:此字段可能返回 null,表示取不到有效值。
PkgBindInfo Array of PkgBind 程序包关联关系
注意:此字段可能返回 null,表示取不到有效值。

PkgList

包列表

被如下接口引用:DescribePkgs。

名称 类型 描述
TotalCount Integer 程序包总量
Content Array of PkgInfo 程序包信息列表
注意:此字段可能返回 null,表示取不到有效值。
RepositoryId String 程序包仓库id
注意:此字段可能返回 null,表示取不到有效值。
RepositoryType String 程序包仓库类型
注意:此字段可能返回 null,表示取不到有效值。
RepositoryName String 程序包仓库名称
注意:此字段可能返回 null,表示取不到有效值。

Ports

服务端口

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

名称 类型 必选 描述
TargetPort Integer 服务端口
Protocol String 端口协议

Program

tsf-privilege模块 Program数据集

被如下接口引用:DescribePrograms。

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

ProgramItem

tsf-privilege模块,数据项

被如下接口引用:DescribePrograms。

名称 类型 必选 描述
ProgramItemId String 数据项ID
注意:此字段可能返回 null,表示取不到有效值。
Resource Resource 资源
注意:此字段可能返回 null,表示取不到有效值。
ValueList Array of String 数据值列表
注意:此字段可能返回 null,表示取不到有效值。
IsAll Boolean 全选标识,true: 全选;false: 非全选
注意:此字段可能返回 null,表示取不到有效值。
CreationTime Integer 创建时间
注意:此字段可能返回 null,表示取不到有效值。
LastUpdateTime Integer 最后更新时间
注意:此字段可能返回 null,表示取不到有效值。
DeleteFlag Boolean 删除标识,true: 可删除;false: 不可删除
注意:此字段可能返回 null,表示取不到有效值。
ProgramId String 数据集ID
注意:此字段可能返回 null,表示取不到有效值。

PropertyField

属性字段

被如下接口引用:DescribeApiDetail。

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

ProtocolPort

端口对象

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

名称 类型 必选 描述
Protocol String TCP UDP
Port Integer 服务端口
TargetPort Integer 容器端口
NodePort Integer 主机端口
注意:此字段可能返回 null,表示取不到有效值。

QuantileEntity

分位数据模型

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

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

RepositoryInfo

仓库信息

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

名称 类型 描述
RepositoryId String 仓库ID
RepositoryName String 仓库名称
注意:此字段可能返回 null,表示取不到有效值。
RepositoryType String 仓库类型(默认仓库:default,私有仓库:private)
注意:此字段可能返回 null,表示取不到有效值。
RepositoryDesc String 仓库描述
注意:此字段可能返回 null,表示取不到有效值。
IsUsed Boolean 仓库是否正在被使用
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 仓库创建时间
注意:此字段可能返回 null,表示取不到有效值。
BucketName String 仓库桶名称
注意:此字段可能返回 null,表示取不到有效值。
BucketRegion String 仓库桶所在地域
注意:此字段可能返回 null,表示取不到有效值。
Directory String 仓库目录
注意:此字段可能返回 null,表示取不到有效值。

RepositoryList

仓库列表

被如下接口引用:DescribeRepositories。

名称 类型 描述
TotalCount Integer 仓库总量
Content Array of RepositoryInfo 仓库信息列表
注意:此字段可能返回 null,表示取不到有效值。

Resource

tsf-privilege 模块,资源

被如下接口引用:DescribePrograms。

名称 类型 必选 描述
ResourceId String 资源ID
注意:此字段可能返回 null,表示取不到有效值。
ResourceCode String 资源编码
注意:此字段可能返回 null,表示取不到有效值。
ResourceName String 资源名称
注意:此字段可能返回 null,表示取不到有效值。
ServiceCode String 资源所属产品编码
注意:此字段可能返回 null,表示取不到有效值。
ResourceAction String 选取资源使用的Action
注意:此字段可能返回 null,表示取不到有效值。
IdField String 资源数据查询的ID字段名
注意:此字段可能返回 null,表示取不到有效值。
NameField String 资源数据查询的名称字段名
注意:此字段可能返回 null,表示取不到有效值。
SelectIdsField String 资源数据查询的ID过滤字段名
注意:此字段可能返回 null,表示取不到有效值。
CreationTime Integer 创建时间
注意:此字段可能返回 null,表示取不到有效值。
LastUpdateTime Integer 最后更新时间
注意:此字段可能返回 null,表示取不到有效值。
DeleteFlag Boolean 删除标识
注意:此字段可能返回 null,表示取不到有效值。
ResourceDesc String 资源描述
注意:此字段可能返回 null,表示取不到有效值。
CanSelectAll Boolean 是否可以选择全部
注意:此字段可能返回 null,表示取不到有效值。
SearchWordField String 资源数据查询的模糊查询字段名
注意:此字段可能返回 null,表示取不到有效值。
Index Integer 排序
注意:此字段可能返回 null,表示取不到有效值。

ResourceFieldRef

k8s env 的 ResourceFieldRef

被如下接口引用:DeployContainerGroup, DescribeContainerGroupDeployInfo。

名称 类型 必选 描述
Resource String k8s 的 Resource
注意:此字段可能返回 null,表示取不到有效值。
示例值:limits.cpu

ResourceTaskStatusResult

资源任务转态结果

被如下接口引用:DescribeResourceTaskStatus。

名称 类型 描述
TaskStatus Integer 任务的执行状态
注意:此字段可能返回 null,表示取不到有效值。

ScalableRule

ScalableRule值

被如下接口引用:DescribeImageRepository。

名称 类型 描述
RuleId String RuleId值
注意:此字段可能返回 null,表示取不到有效值。
Name String Name值
注意:此字段可能返回 null,表示取不到有效值。
ExpandVmCountLimit Integer ExpandVmCountLimit值
注意:此字段可能返回 null,表示取不到有效值。
ShrinkVmCountLimit Integer ShrinkVmCountLimit值
注意:此字段可能返回 null,表示取不到有效值。
GroupCount Integer GroupCount值
注意:此字段可能返回 null,表示取不到有效值。
Desc String 备注
注意:此字段可能返回 null,表示取不到有效值。
Description String 备注
注意:此字段可能返回 null,表示取不到有效值。
DisableMetricAS Integer 是否关闭指标伸缩, 默认0, 0:打开指标伸缩 1:关闭指标伸缩
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
EnableCronAS Integer 开启定时伸缩规则, 默认0, 0:关闭定时伸缩 1:开启定时伸缩
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

SchedulingStrategy

tsf 容器集群节点调度策略

被如下接口引用:DeployContainerGroup。

名称 类型 必选 描述
Type String NONE:不使用调度策略;CROSS_AZ:跨可用区部署
注意:此字段可能返回 null,表示取不到有效值。

ServiceConfig

服务配置

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

名称 类型 必选 描述
Name String 服务名
Ports Array of Ports 端口信息列表
HealthCheck HealthCheckConfig 健康检查配置
注意:此字段可能返回 null,表示取不到有效值。

ServiceSetting

容器网络设置。

被如下接口引用:DeployContainerGroup。

名称 类型 必选 描述
AccessType Integer 0:公网, 1:集群内访问, 2:NodePort, 3: VPC 内网访问
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
ProtocolPorts Array of ProtocolPort 容器端口映射
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]
SubnetId String 子网ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:subnet-d15zonly
DisableService Boolean 是否创建 k8s service,默认为 false
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
HeadlessService Boolean service 是否为 headless 类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
AllowDeleteService Boolean 当为 true 且 DisableService 也为 true 时,会删除之前创建的 service,请小心使用
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
OpenSessionAffinity Boolean 开启SessionAffinity,true为开启,false为不开启,默认为false
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
SessionAffinityTimeoutSeconds Integer SessionAffinity会话时间,默认10800
注意:此字段可能返回 null,表示取不到有效值。
示例值:10800

ServiceStatisticsResult

服务统计结果

被如下接口引用:DescribeStatistics。

名称 类型 描述
Path String 请求模板路径:type为接口时返回,服务时不返回
注意:此字段可能返回 null,表示取不到有效值。
Method String 请求方法:type为接口时返回,服务时不返回
注意:此字段可能返回 null,表示取不到有效值。
MicroserviceId String 微服务Id
MicroserviceName String 微服务名称
RequestCount Integer 请求数
ErrorRate Float 请求错误率,不带百分号
AvgTimeConsuming Float 平均响应耗时ms
MetricDataCurves Array of MetricDataCurve 响应耗时曲线
InstanceId String 实例id
注意:此字段可能返回 null,表示取不到有效值。
InstanceName String 实例name
注意:此字段可能返回 null,表示取不到有效值。
GroupId String 部署组id
注意:此字段可能返回 null,表示取不到有效值。
GroupName String 部署组name
注意:此字段可能返回 null,表示取不到有效值。
ClusterType String 部署组类型
注意:此字段可能返回 null,表示取不到有效值。
GroupExist Integer 部署组是否存在
注意:此字段可能返回 null,表示取不到有效值。
InstanceExist Integer 实例是否存在,仅限cvm
注意:此字段可能返回 null,表示取不到有效值。
ApplicationId String 应用id
注意:此字段可能返回 null,表示取不到有效值。
MicroserviceType String 微服务类型
注意:此字段可能返回 null,表示取不到有效值。
CpuPercent Integer cpu使用率
注意:此字段可能返回 null,表示取不到有效值。
HeapUsed Integer 已用堆大小,单位KB
注意:此字段可能返回 null,表示取不到有效值。
DbName String 数据库
注意:此字段可能返回 null,表示取不到有效值。
Script String Script值
注意:此字段可能返回 null,表示取不到有效值。
DbType String 数据库类型
注意:此字段可能返回 null,表示取不到有效值。
Apdex Float Apdex值
注意:此字段可能返回 null,表示取不到有效值。
Qps Float Qps值
注意:此字段可能返回 null,表示取不到有效值。
InstanceOnlineCount Integer 实例在线数
注意:此字段可能返回 null,表示取不到有效值。
InstanceTotalCount Integer 实例总数
注意:此字段可能返回 null,表示取不到有效值。
Status String normal/error
注意:此字段可能返回 null,表示取不到有效值。
ErrorRateLevel String normal/warn/error
注意:此字段可能返回 null,表示取不到有效值。
AvgTimeConsumingLevel String normal/warn/error
注意:此字段可能返回 null,表示取不到有效值。
ApdexLevel String normal/warn/error
注意:此字段可能返回 null,表示取不到有效值。

ServiceStatisticsResults

服务统计结果集

被如下接口引用:DescribeStatistics。

名称 类型 描述
Content Array of ServiceStatisticsResult 返回结果
注意:此字段可能返回 null,表示取不到有效值。
TotalCount Integer 条数
注意:此字段可能返回 null,表示取不到有效值。

ShardArgument

分片参数

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

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

SimpleApplication

简单应用

被如下接口引用:DescribeSimpleApplications。

名称 类型 描述
ApplicationId String 应用ID
注意:此字段可能返回 null,表示取不到有效值。
ApplicationName String 应用名称
注意:此字段可能返回 null,表示取不到有效值。
ApplicationType String 应用类型
注意:此字段可能返回 null,表示取不到有效值。
MicroserviceType String 应用微服务类型
注意:此字段可能返回 null,表示取不到有效值。
ApplicationDesc String ApplicationDesc
注意:此字段可能返回 null,表示取不到有效值。
ProgLang String ProgLang
注意:此字段可能返回 null,表示取不到有效值。
ApplicationResourceType String ApplicationResourceType
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String CreateTime
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime String UpdateTime
注意:此字段可能返回 null,表示取不到有效值。
ApigatewayServiceId String ApigatewayServiceId
注意:此字段可能返回 null,表示取不到有效值。
ApplicationRuntimeType String ApplicationRuntimeType
注意:此字段可能返回 null,表示取不到有效值。

SimpleGroup

部署组

被如下接口引用:DescribeSimpleGroups。

名称 类型 描述
GroupId String 部署组ID
注意:此字段可能返回 null,表示取不到有效值。
GroupName String 部署组名称
注意:此字段可能返回 null,表示取不到有效值。
ApplicationId String 应用ID
注意:此字段可能返回 null,表示取不到有效值。
ApplicationName String 应用名称
注意:此字段可能返回 null,表示取不到有效值。
ApplicationType String 应用类型
注意:此字段可能返回 null,表示取不到有效值。
ClusterId String 集群ID
注意:此字段可能返回 null,表示取不到有效值。
ClusterName String 集群名称
注意:此字段可能返回 null,表示取不到有效值。
ClusterType String 集群类型
注意:此字段可能返回 null,表示取不到有效值。
NamespaceId String 命名空间ID
注意:此字段可能返回 null,表示取不到有效值。
NamespaceName String 命名空间名称
注意:此字段可能返回 null,表示取不到有效值。
StartupParameters String 启动参数
注意:此字段可能返回 null,表示取不到有效值。
GroupResourceType String 部署组资源类型
注意:此字段可能返回 null,表示取不到有效值。
AppMicroServiceType String 应用微服务类型
注意:此字段可能返回 null,表示取不到有效值。

SimpleKafkaDeliveryConfig

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

被如下接口引用:DescribeDeliveryConfigByGroupId。

名称 类型 描述
ConfigId String 配置项id
注意:此字段可能返回 null,表示取不到有效值。
ConfigName String 配置项名称
注意:此字段可能返回 null,表示取不到有效值。

StdoutLogV2

标准输出日志

被如下接口引用:SearchStdoutLog。

名称 类型 描述
InstanceId String 实例ID
注意:此字段可能返回 null,表示取不到有效值。
Content String 日志内容
注意:此字段可能返回 null,表示取不到有效值。
Timestamp Integer 日志时间戳
注意:此字段可能返回 null,表示取不到有效值。
InstanceIp String 实例IP
注意:此字段可能返回 null,表示取不到有效值。

TaskFlowEdge

工作流图中的边

被如下接口引用:CreateTaskFlow。

名称 类型 描述
NodeId String 节点 ID
ChildNodeId String 子节点 ID
注意:此字段可能返回 null,表示取不到有效值。
CoreNode String 是否核心任务,Y/N
注意:此字段可能返回 null,表示取不到有效值。
EdgeType String 边类型
注意:此字段可能返回 null,表示取不到有效值。
NodeType String 任务节点类型
PositionX String X轴坐标位置
注意:此字段可能返回 null,表示取不到有效值。
PositionY String Y轴坐标位置
注意:此字段可能返回 null,表示取不到有效值。
GraphId String 图 ID
注意:此字段可能返回 null,表示取不到有效值。
FlowId String 工作流 ID
注意:此字段可能返回 null,表示取不到有效值。
NodeName String 节点名称
注意:此字段可能返回 null,表示取不到有效值。
TaskId String 任务ID
注意:此字段可能返回 null,表示取不到有效值。
TaskLogId String 任务历史ID
注意:此字段可能返回 null,表示取不到有效值。

TaskFlowLastBatchState

工作流最近批次的状态

被如下接口引用:DescribeFlowLastBatchState。

名称 类型 描述
FlowBatchId String 批次ID
注意:此字段可能返回 null,表示取不到有效值。
FlowBatchLogId String 批次历史ID
注意:此字段可能返回 null,表示取不到有效值。
State String 状态,WAITING/SUCCESS/FAILED/RUNNING/TERMINATING
注意:此字段可能返回 null,表示取不到有效值。

TaskId

任务id

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

名称 类型 描述
TaskId String 任务ID
注意:此字段可能返回 null,表示取不到有效值。

TaskLastExecuteStatus

任务最近一次执行状态

被如下接口引用:DescribeTaskLastStatus。

名称 类型 描述
BatchId String 批次ID
注意:此字段可能返回 null,表示取不到有效值。
State String 运行状态,RUNNING/SUCCESS/FAIL/HALF/TERMINATED
注意:此字段可能返回 null,表示取不到有效值。
BatchLogId String 批次历史ID
注意:此字段可能返回 null,表示取不到有效值。

TaskRecord

任务定义

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

名称 类型 描述
TaskName String 任务名称
TaskType String 任务类型
ExecuteType String 执行类型
TaskContent String 任务内容,长度限制65535字节
GroupId String 分组ID
TimeOut Integer 超时时间
RetryCount Integer 重试次数
注意:此字段可能返回 null,表示取不到有效值。
RetryInterval Integer 重试间隔
注意:此字段可能返回 null,表示取不到有效值。
TaskRule TaskRule 触发规则
TaskState String 是否启用任务,ENABLED/DISABLED
TaskId String 任务ID
SuccessOperator String 判断任务成功的操作符
注意:此字段可能返回 null,表示取不到有效值。
SuccessRatio Integer 判断任务成功的阈值
注意:此字段可能返回 null,表示取不到有效值。
ShardCount Integer 分片数量
注意:此字段可能返回 null,表示取不到有效值。
AdvanceSettings AdvanceSettings 高级设置
注意:此字段可能返回 null,表示取不到有效值。
ShardArguments Array of ShardArgument 分片参数
注意:此字段可能返回 null,表示取不到有效值。
BelongFlowIds Array of String 所属工作流ID
注意:此字段可能返回 null,表示取不到有效值。
TaskLogId String 任务历史ID
注意:此字段可能返回 null,表示取不到有效值。
TriggerType String 触发类型
注意:此字段可能返回 null,表示取不到有效值。
TaskArgument String 任务参数,长度限制10000个字符
注意:此字段可能返回 null,表示取不到有效值。

TaskRecordPage

翻页查询的任务记录返回

被如下接口引用:DescribeTaskRecords。

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

TaskRule

任务规则

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

名称 类型 必选 描述
RuleType String 触发规则类型, Cron/Repeat
示例值:Cron
Expression String Cron类型规则,cron表达式。
注意:此字段可能返回 null,表示取不到有效值。
示例值:0 0/1 * * * ?
RepeatInterval Integer 时间间隔, 单位毫秒
注意:此字段可能返回 null,表示取不到有效值。
示例值:0

TcrRepoInfo

tcr仓库信息

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

名称 类型 必选 描述
Region String 地域(填数字)
注意:此字段可能返回 null,表示取不到有效值。
RegistryId String 实例id
注意:此字段可能返回 null,表示取不到有效值。
RegistryName String 实例名
注意:此字段可能返回 null,表示取不到有效值。
Namespace String 命名空间
注意:此字段可能返回 null,表示取不到有效值。
RepoName String 仓库名
注意:此字段可能返回 null,表示取不到有效值。

ThreadPicture

jvm监控数据线程数据封装

被如下接口引用:DescribeJvmMonitor。

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

TsfApiListResponse

TsfApiListResponse

被如下接口引用:DescribeMsApiList。

名称 类型 描述
TotalCount Integer 数量
注意:此字段可能返回 null,表示取不到有效值。
Content Array of MsApiArray API 列表
注意:此字段可能返回 null,表示取不到有效值。

TsfConfigCenter

配置中心

被如下接口引用:ReleaseConfigWithDetailResp。

名称 类型 必选 描述
ConfigType String 配置中心类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:SHARE/EXCLUSIVE
ConfigCenterInstanceId String 配置中心实例id
注意:此字段可能返回 null,表示取不到有效值。
示例值:ins-0e02e26d
ConfigCenterInstanceName String 配置中心实例名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:lzmmm
RegionId String 实例地域id
注意:此字段可能返回 null,表示取不到有效值。
示例值:33
NamespaceId String 命名空间id
注意:此字段可能返回 null,表示取不到有效值。
示例值:namespace-byxkpkal

TsfPageApiDetailInfo

ApiDetailInfo 翻页对象

被如下接口引用:DescribeGatewayApis。

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

TsfPageApiGroupInfo

ApiGroupInfo翻页结构体

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

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

TsfPageApplication

应用分页信息

被如下接口引用:DescribeApplications。

名称 类型 描述
TotalCount Integer 应用总数目
注意:此字段可能返回 null,表示取不到有效值。
Content Array of ApplicationForPage 应用信息列表
注意:此字段可能返回 null,表示取不到有效值。

TsfPageBusinessLogConfig

业务日志配置项列表

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

名称 类型 描述
TotalCount Integer 总条数
注意:此字段可能返回 null,表示取不到有效值。
Content Array of BusinessLogConfig 业务日志配置项列表
注意:此字段可能返回 null,表示取不到有效值。

TsfPageBusinessLogV2

业务日志列表

被如下接口引用:SearchBusinessLog。

名称 类型 描述
TotalCount Integer 总条数
注意:此字段可能返回 null,表示取不到有效值。
Content Array of BusinessLogV2 业务日志列表
注意:此字段可能返回 null,表示取不到有效值。
ScrollId String 游标ID
注意:此字段可能返回 null,表示取不到有效值。
Status String 查询状态
注意:此字段可能返回 null,表示取不到有效值。

TsfPageCluster

Tsf分页集群对象

被如下接口引用:DescribeSimpleClusters。

名称 类型 描述
TotalCount Integer 总条数
注意:此字段可能返回 null,表示取不到有效值。
Content Array of Cluster 集群列表
注意:此字段可能返回 null,表示取不到有效值。

TsfPageClusterV2

Tsf分页集群对象

被如下接口引用:DescribeClusters。

名称 类型 描述
TotalCount Integer 集群总数目
注意:此字段可能返回 null,表示取不到有效值。
Content Array of ClusterV2 集群列表
注意:此字段可能返回 null,表示取不到有效值。

TsfPageConfig

TsfPage

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

名称 类型 描述
TotalCount Integer TsfPageConfig
Content Array of Config 配置项列表

TsfPageConfigRelease

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

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

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

TsfPageConfigReleaseLog

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

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

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

TsfPageContainerEvent

分页的 ContainerEvent

被如下接口引用:DescribeContainerEvents。

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

TsfPageDimension

维度分页

被如下接口引用:DescribeInvocationMetricDataDimension。

名称 类型 描述
TotalCount Integer 总数
示例值:0
Content Array of String 维度

TsfPageFileConfig

文件配置项列表

被如下接口引用:DescribeFileConfigs。

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

TsfPageFileConfigRelease

文件配置项发布信息列表

被如下接口引用:DescribeFileConfigReleases。

名称 类型 描述
TotalCount Integer 数量
注意:此字段可能返回 null,表示取不到有效值。
Content Array of FileConfigRelease 列表
注意:此字段可能返回 null,表示取不到有效值。

TsfPageGatewayDeployGroup

GatewayDeployGroup 翻页对象

被如下接口引用:DescribeGroupBindedGateways。

名称 类型 描述
TotalCount Integer 记录总数
Content Array of GatewayDeployGroup 记录实体列表

TsfPageGatewayPlugin

GatewayPlugin 翻页对象

被如下接口引用:DescribePluginInstances。

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

TsfPageInstance

TSF机器实例分页对象

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

名称 类型 描述
TotalCount Integer 机器实例总数目
注意:此字段可能返回 null,表示取不到有效值。
Content Array of Instance 机器实例列表
注意:此字段可能返回 null,表示取不到有效值。

TsfPageMicroservice

微服务列表信息

被如下接口引用:DescribeMicroservices。

名称 类型 描述
TotalCount Integer 微服务总数目
注意:此字段可能返回 null,表示取不到有效值。
Content Array of Microservice 微服务列表信息
注意:此字段可能返回 null,表示取不到有效值。

TsfPageMsInstance

微服务实例的分页内容

被如下接口引用:DescribeMicroservice。

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

TsfPageNamespace

Tsf命名空间分页对象

被如下接口引用:DescribeSimpleNamespaces。

名称 类型 描述
TotalCount Integer 命名空间总条数
注意:此字段可能返回 null,表示取不到有效值。
Content Array of Namespace 命名空间列表
注意:此字段可能返回 null,表示取不到有效值。

TsfPageSimpleApplication

TSF分页简单应用对象

被如下接口引用:DescribeSimpleApplications。

名称 类型 描述
TotalCount Integer 总条数
注意:此字段可能返回 null,表示取不到有效值。
Content Array of SimpleApplication 简单应用列表
注意:此字段可能返回 null,表示取不到有效值。

TsfPageSimpleGroup

TSF简单部署组分页列表

被如下接口引用:DescribeSimpleGroups。

名称 类型 描述
TotalCount Integer 总条数
注意:此字段可能返回 null,表示取不到有效值。
Content Array of SimpleGroup 简单部署组列表
注意:此字段可能返回 null,表示取不到有效值。

TsfPageStdoutLogV2

标准输出日志列表

被如下接口引用:SearchStdoutLog。

名称 类型 描述
TotalCount Integer 总条数
注意:此字段可能返回 null,表示取不到有效值。
Content Array of StdoutLogV2 标准输出日志列表
注意:此字段可能返回 null,表示取不到有效值。
ScrollId String 游标ID
注意:此字段可能返回 null,表示取不到有效值。
Status String 查询状态
注意:此字段可能返回 null,表示取不到有效值。

TsfPageUnitNamespace

单元化命名空间翻页对象

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

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

TsfPageUnitRule

单元化规则翻页对象

被如下接口引用:DescribeUnitRules。

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

TsfPageUnitRuleV2

单元化规则翻页对象

被如下接口引用:DescribeUnitRulesV2。

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

TsfPageVmGroup

列表中部署组分页信息

被如下接口引用:DescribeGroups。

名称 类型 描述
TotalCount Integer 虚拟机部署组总数目
注意:此字段可能返回 null,表示取不到有效值。
Content Array of VmGroupSimple 虚拟机部署组列表信息
注意:此字段可能返回 null,表示取不到有效值。

UnitNamespace

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

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

名称 类型 必选 描述
NamespaceId String 命名空间ID
NamespaceName String 命名空间Name
Id String 单元化命名空间ID
注意:此字段可能返回 null,表示取不到有效值。
GatewayInstanceId String 网关实体ID
注意:此字段可能返回 null,表示取不到有效值。
CreatedTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
UpdatedTime String 更新时间
注意:此字段可能返回 null,表示取不到有效值。

UnitRule

微服务网关单元化规则

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

名称 类型 必选 描述
Name String 规则名称
Id String 规则ID
注意:此字段可能返回 null,表示取不到有效值。
GatewayInstanceId String 网关实体ID
注意:此字段可能返回 null,表示取不到有效值。
Description String 规则描述
注意:此字段可能返回 null,表示取不到有效值。
Status String 使用状态:enabled/disabled
注意:此字段可能返回 null,表示取不到有效值。
UnitRuleItemList Array of UnitRuleItem 规则项列表
注意:此字段可能返回 null,表示取不到有效值。
CreatedTime String CreatedTime
注意:此字段可能返回 null,表示取不到有效值。
UpdatedTime String UpdatedTime
注意:此字段可能返回 null,表示取不到有效值。

UnitRuleItem

微服务网关单元化规则项

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

名称 类型 必选 描述
Relationship String 逻辑关系:AND/OR
DestNamespaceId String 目的地命名空间ID
DestNamespaceName String 目的地命名空间名称
Name String 规则项名称
Id String 规则项ID
注意:此字段可能返回 null,表示取不到有效值。
UnitRuleId String 单元化规则ID
注意:此字段可能返回 null,表示取不到有效值。
Priority Integer 规则顺序,越小优先级越高:默认为0
注意:此字段可能返回 null,表示取不到有效值。
Description String 规则描述
注意:此字段可能返回 null,表示取不到有效值。
UnitRuleTagList Array of UnitRuleTag 规则标签列表
注意:此字段可能返回 null,表示取不到有效值。
ItemIndex Integer 规则项索引
注意:此字段可能返回 null,表示取不到有效值。
CreatedTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
UpdatedTime String 修改时间
注意:此字段可能返回 null,表示取不到有效值。

UnitRuleTag

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

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

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

ValueFrom

k8s env 的 ValueFrom

被如下接口引用:DeployContainerGroup, DescribeContainerGroupDeployInfo。

名称 类型 必选 描述
FieldRef FieldRef k8s env 的 FieldRef
注意:此字段可能返回 null,表示取不到有效值。
ResourceFieldRef ResourceFieldRef k8s env 的 ResourceFieldRef
注意:此字段可能返回 null,表示取不到有效值。

VmGroup

虚拟机部署组信息

被如下接口引用:DescribeGroup。

名称 类型 描述
GroupId String 部署组ID
注意:此字段可能返回 null,表示取不到有效值。
GroupName String 部署组名称
注意:此字段可能返回 null,表示取不到有效值。
GroupStatus String 部署组状态
注意:此字段可能返回 null,表示取不到有效值。
PackageId String 程序包ID
注意:此字段可能返回 null,表示取不到有效值。
PackageName String 程序包名称
注意:此字段可能返回 null,表示取不到有效值。
PackageVersion String 程序包版本号
注意:此字段可能返回 null,表示取不到有效值。
ClusterId String 集群ID
注意:此字段可能返回 null,表示取不到有效值。
ClusterName String 集群名称
注意:此字段可能返回 null,表示取不到有效值。
NamespaceId String 命名空间ID
注意:此字段可能返回 null,表示取不到有效值。
NamespaceName String 命名空间名称
注意:此字段可能返回 null,表示取不到有效值。
ApplicationId String 应用ID
注意:此字段可能返回 null,表示取不到有效值。
ApplicationName String 应用名称
注意:此字段可能返回 null,表示取不到有效值。
InstanceCount Integer 部署组机器数目
注意:此字段可能返回 null,表示取不到有效值。
RunInstanceCount Integer 部署组运行中机器数目
注意:此字段可能返回 null,表示取不到有效值。
StartupParameters String 部署组启动参数信息
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 部署组创建时间
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime String 部署组更新时间
注意:此字段可能返回 null,表示取不到有效值。
OffInstanceCount Integer 部署组停止机器数目
注意:此字段可能返回 null,表示取不到有效值。
GroupDesc String 部署组描述信息
注意:此字段可能返回 null,表示取不到有效值。
MicroserviceType String 微服务类型
注意:此字段可能返回 null,表示取不到有效值。
ApplicationType String 应用类型
注意:此字段可能返回 null,表示取不到有效值。
GroupResourceType String 部署组资源类型
注意:此字段可能返回 null,表示取不到有效值。
UpdatedTime Integer 部署组更新时间戳
注意:此字段可能返回 null,表示取不到有效值。
DeployDesc String 部署应用描述信息
注意:此字段可能返回 null,表示取不到有效值。
UpdateType Integer 滚动发布的更新方式
注意:此字段可能返回 null,表示取不到有效值。
DeployBetaEnable Boolean 发布是否启用beta批次
注意:此字段可能返回 null,表示取不到有效值。
DeployBatch Array of Float 滚动发布的批次比例列表
注意:此字段可能返回 null,表示取不到有效值。
DeployExeMode String 滚动发布的批次执行方式
注意:此字段可能返回 null,表示取不到有效值。
DeployWaitTime Integer 滚动发布的每个批次的等待时间
注意:此字段可能返回 null,表示取不到有效值。
EnableHealthCheck Boolean 是否开启了健康检查
注意:此字段可能返回 null,表示取不到有效值。
HealthCheckSettings HealthCheckSettings 健康检查配置
注意:此字段可能返回 null,表示取不到有效值。
PackageType String 程序包类型
注意:此字段可能返回 null,表示取不到有效值。
StartScript String 启动脚本 base64编码
注意:此字段可能返回 null,表示取不到有效值。
StopScript String 停止脚本 base64编码
注意:此字段可能返回 null,表示取不到有效值。
Alias String 部署组备注
注意:此字段可能返回 null,表示取不到有效值。
示例值:备注
AgentProfileList Array of AgentProfile javaagent信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:SERVICE_AGENT/OT_AGENT
WarmupSetting WarmupSetting 预热属性配置
注意:此字段可能返回 null,表示取不到有效值。
GatewayConfig GatewayConfig Envoy网关配置
注意:此字段可能返回 null,表示取不到有效值。
EnableBatchHealthCheck Boolean 批次是否开启健康检查
注意:此字段可能返回 null,表示取不到有效值。

VmGroupOther

虚拟机部署组其他字段

被如下接口引用:DescribeGroupAttribute。

名称 类型 描述
GroupId String 部署组ID
注意:此字段可能返回 null,表示取不到有效值。
PackageId String 程序包ID
注意:此字段可能返回 null,表示取不到有效值。
PackageName String 程序包名称
注意:此字段可能返回 null,表示取不到有效值。
PackageVersion String 程序包版本
注意:此字段可能返回 null,表示取不到有效值。
InstanceCount Integer 部署组实例数
注意:此字段可能返回 null,表示取不到有效值。
RunInstanceCount Integer 部署组运行中实例数
注意:此字段可能返回 null,表示取不到有效值。
OffInstanceCount Integer 部署组中停止实例数
注意:此字段可能返回 null,表示取不到有效值。
GroupStatus String 部署组状态
注意:此字段可能返回 null,表示取不到有效值。
IsNotEqualServiceConfig Boolean 服务配置信息是否匹配
注意:此字段可能返回 null,表示取不到有效值。
HealthCheckSettings HealthCheckSettings HealthCheckSettings
注意:此字段可能返回 null,表示取不到有效值。

VmGroupSimple

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

被如下接口引用:DescribeGroups。

名称 类型 描述
GroupId String 部署组ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:group-xyz
GroupName String 部署组名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:foo
ApplicationType String 应用类型
注意:此字段可能返回 null,表示取不到有效值。
GroupDesc String 部署组描述
注意:此字段可能返回 null,表示取不到有效值。
UpdateTime String 部署组更新时间
注意:此字段可能返回 null,表示取不到有效值。
ClusterId String 集群ID
注意:此字段可能返回 null,表示取不到有效值。
StartupParameters String 部署组启动参数
注意:此字段可能返回 null,表示取不到有效值。
NamespaceId String 命名空间ID
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 部署组创建时间
注意:此字段可能返回 null,表示取不到有效值。
ClusterName String 集群名称
注意:此字段可能返回 null,表示取不到有效值。
ApplicationId String 应用ID
注意:此字段可能返回 null,表示取不到有效值。
ApplicationName String 应用名称
注意:此字段可能返回 null,表示取不到有效值。
NamespaceName String 命名空间名称
注意:此字段可能返回 null,表示取不到有效值。
MicroserviceType String 应用微服务类型
注意:此字段可能返回 null,表示取不到有效值。
GroupResourceType String 部署组资源类型
注意:此字段可能返回 null,表示取不到有效值。
UpdatedTime Integer 部署组更新时间戳
注意:此字段可能返回 null,表示取不到有效值。
DeployDesc String 部署应用描述信息
注意:此字段可能返回 null,表示取不到有效值。
Alias String 部署组备注
注意:此字段可能返回 null,表示取不到有效值。
示例值:备注

VolumeInfo

容器卷挂载信息

被如下接口引用:DeployContainerGroup, DescribeContainerGroupDeployInfo。

名称 类型 必选 描述
VolumeType String 数据卷类型
示例值:emptyDir
VolumeName String 数据卷名称
VolumeConfig String 数据卷配置

VolumeMountInfo

容器卷挂载点信息

被如下接口引用:DeployContainerGroup, DescribeContainerGroupDeployInfo。

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

WarmupSetting

预热配置

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

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