有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

Autoscaler

弹性伸缩策略组合

被如下接口引用:CreateApplicationAutoscaler, DescribeApplicationAutoscalerList, DescribeApplicationInfo, ModifyApplicationAutoscaler。

名称 类型 必选 描述
MinReplicas Integer 弹性伸缩最小实例数
示例值:1
MaxReplicas Integer 弹性伸缩最大实例数
示例值:1
HorizontalAutoscaler Array of HorizontalAutoscaler 指标弹性伸缩策略
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
CronHorizontalAutoscaler Array of CronHorizontalAutoscaler 定时弹性伸缩策略
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
AutoscalerId String 弹性伸缩ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
AutoscalerName String 弹性伸缩名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Description String 弹性伸缩描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
CreateDate String 创建日期
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ModifyDate String 修改时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
EnableDate String 启用时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Enabled Boolean 是否启用
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

ConfigData

配置

被如下接口引用:DescribeConfigData, DescribeConfigDataList。

名称 类型 描述
Name String 配置名称
示例值:xxx
CreateTime String 创建时间
示例值:2012-12-10 09:00:00
RelatedApplications Array of TemService 关联的服务列表
示例值:[]
Data Array of Pair 配置条目
示例值:[]

CosToken

Cos token

被如下接口引用:CreateCosToken。

名称 类型 描述
RequestId String 唯一请求 ID
示例值:1
Bucket String 存储桶桶名
示例值:1
Region String 存储桶所在区域
示例值:1
TmpSecretId String 临时密钥的SecretId
示例值:1
TmpSecretKey String 临时密钥的SecretKey
示例值:1
SessionToken String 临时密钥的 sessionToken
示例值:1
StartTime String 临时密钥获取的开始时间
示例值:1
ExpiredTime String 临时密钥的 expiredTime
示例值:1
FullPath String 包完整路径
示例值:1

CronHorizontalAutoscaler

定时伸缩策略

被如下接口引用:CreateApplicationAutoscaler, DeployApplication, DescribeApplicationAutoscalerList, DescribeApplicationInfo, ModifyApplicationAutoscaler。

名称 类型 必选 描述
Name String 定时伸缩策略名称
示例值:1
Period String 策略周期
* * ,三个范围,第一个是天,第二个是月,第三个是周,中间用空格隔开
例子:
* * (每天)
* * 0-3 (每周日到周三)
1,11,21 * (每个月1号,11号,21号)
示例值:
* *
Schedules Array of CronHorizontalAutoscalerSchedule 定时伸缩策略明细
示例值:1
Enabled Boolean 是否启用
示例值:1
Priority Integer 策略优先级,值越大优先级越高,0为最小值
示例值:1

CronHorizontalAutoscalerSchedule

定时伸缩策略明细

被如下接口引用:CreateApplicationAutoscaler, DeployApplication, DescribeApplicationAutoscalerList, DescribeApplicationInfo, ModifyApplicationAutoscaler。

名称 类型 必选 描述
StartAt String 触发事件,小时分钟,用:分割
例如
00:00(零点零分触发)
示例值:00:00
TargetReplicas Integer 目标实例数(不大于50)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

DeployServiceBatchDetail

分批发布单批次详情

被如下接口引用:DescribeDeployApplicationDetail。

名称 类型 必选 描述
OldPodList DeployServicePodDetail 旧实例列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:[1]
NewPodList DeployServicePodDetail 新实例列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:[1]
BatchStatus String 当前批次状态:"WaitForTimeExceed", "WaitForResume", "Deploying", "Finish", "NotStart"
注意:此字段可能返回 null,表示取不到有效值。
示例值:Finish
PodNum Integer 该批次预计旧实例数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:3
BatchIndex Integer 批次id
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
OldPods Array of DeployServicePodDetail 旧实例列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:[1]
NewPods Array of DeployServicePodDetail 新实例列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:[1]
NextBatchStartTime Integer =0:手动确认批次;>0:下一批次开始时间戳
注意:此字段可能返回 null,表示取不到有效值。
示例值:0

DeployServicePodDetail

分批发布单批次详情

被如下接口引用:DescribeDeployApplicationDetail。

名称 类型 必选 描述
PodId String pod Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:pod-123
PodStatus Array of String pod状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:Pending
PodVersion String pod版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:v1.1
CreateTime String pod创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2020-01-01 11:11:11
Zone String pod所在可用区
注意:此字段可能返回 null,表示取不到有效值。
示例值:shanghai-zone-4
Webshell String webshell地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:webshell
Status String 状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

DeployStrategyConf

分批发布策略配置

被如下接口引用:DeployApplication, DescribeApplicationInfo, DescribeDeployApplicationDetail。

名称 类型 必选 描述
TotalBatchCount Integer 总分批数
示例值:10
BetaBatchNum Integer beta分批实例数
示例值:5
DeployStrategyType Integer 分批策略:0-全自动,1-全手动,2-beta分批,beta批一定是手动的,3-首次发布
示例值:1
BatchInterval Integer 每批暂停间隔
示例值:200
MinAvailable Integer 最小可用实例数
示例值:1
Force Boolean 是否强制发布
示例值:false

DescribeConfigDataListPage

配置信息的分页列表

被如下接口引用:DescribeConfigDataList。

名称 类型 描述
Records Array of ConfigData 记录
示例值:[]
ContinueToken String 分页游标,用以查询下一页
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx
RemainingCount Integer 剩余数目
注意:此字段可能返回 null,表示取不到有效值。
示例值:22

DescribeRunPodPage

版本pod列表

被如下接口引用:DescribeApplicationInfo, DescribeApplicationPods, DescribeApplicationsStatus, DescribeDeployApplicationDetail。

名称 类型 描述
Offset Integer 分页下标
示例值:1
Limit Integer 单页条数
示例值:11
TotalCount Integer 总数
示例值:111
RequestId String 请求id
示例值:ssss
PodList Array of RunVersionPod 条目
示例值:{name:key}

EksService

eks service info

被如下接口引用:DeployApplication, DescribeApplicationInfo, DescribeApplicationServiceList, ModifyApplicationService。

名称 类型 必选 描述
Name String service name
示例值:xxx
Ports Array of Integer 可用端口
示例值:[1,2]
Yaml String yaml 内容
示例值:1
ApplicationName String 服务名
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx
VersionName String 版本名
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxxx
ClusterIp Array of String 内网ip
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ExternalIp String 外网ip
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Type String 访问类型,可选值:
- EXTERNAL(公网访问)
- VPC(vpc内访问)
- CLUSTER(集群内访问)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SubnetId String 子网ID,只在类型为vpc访问时才有值
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
LoadBalanceId String 负载均衡ID,只在外网访问和vpc内访问才有值,默认自动创建
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PortMappings Array of PortMapping 端口映射
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ServicePortMappingList Array of ServicePortMapping 每种类型访问配置详情
注意:此字段可能返回 null,表示取不到有效值。
示例值:[{"name":"test"}]
FlushAll Boolean 刷新复写所有类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
EnableRegistryNextDeploy Integer 1: 下次部署自动注入注册中心信息;0:不注入
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ApplicationId String 返回应用id
注意:此字段可能返回 null,表示取不到有效值。
示例值:app-123
AllIpDone Boolean 所有服务IP是否已经ready
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
ExternalDomain String clb 域名
注意:此字段可能返回 null,表示取不到有效值。
示例值:lb-xxxx.com

EnablePrometheusConf

开启prometheus监控配置

被如下接口引用:DeployApplication, DescribeApplicationInfo。

名称 类型 必选 描述
Port Integer 应用开放的监听端口
示例值:9090
Path String 业务指标暴露的url path
示例值:/metrics

EsInfo

弹性伸缩配置

被如下接口引用:DeployApplication, DescribeApplicationInfo。

名称 类型 必选 描述
MinAliveInstances Integer 最小实例数
示例值:1
MaxAliveInstances Integer 最大实例数
示例值:5
EsStrategy Integer 弹性策略,1:cpu,2:内存
示例值:1
Threshold Integer 弹性扩缩容条件值
示例值:50
VersionId String 版本Id
示例值:version-test

HealthCheckConfig

健康检查配置

被如下接口引用:DeployApplication, DescribeApplicationInfo。

名称 类型 必选 描述
Type String 支持的健康检查类型,如 HttpGet,TcpSocket,Exec
示例值:HttpGet
Protocol String 仅当健康检查类型为 HttpGet 时有效,表示协议类型,如 HTTP,HTTPS
示例值:HTTP
Path String 仅当健康检查类型为 HttpGet 时有效,表示请求路径
示例值:/xxx
Exec String 仅当健康检查类型为 Exec 时有效,表示执行的脚本内容
示例值:xxxx
Port Integer 仅当健康检查类型为 HttpGet\TcpSocket 时有效,表示请求路径
示例值:80
InitialDelaySeconds Integer 检查延迟开始时间,单位为秒,默认为 0
示例值:0
TimeoutSeconds Integer 超时时间,单位为秒,默认为 1
示例值:1
PeriodSeconds Integer 间隔时间,单位为秒,默认为 10
示例值:10

HorizontalAutoscaler

弹性伸缩策略

被如下接口引用:CreateApplicationAutoscaler, DeployApplication, DescribeApplicationAutoscalerList, DescribeApplicationInfo, ModifyApplicationAutoscaler。

名称 类型 必选 描述
MinReplicas Integer 最小实例数(可以不传)
示例值:1
MaxReplicas Integer 最大实例数(可以不传)
示例值:1
Metrics String 指标度量
CPU(CPU使用率,%)
MEMORY(内存使用率,%)
CPU_CORE_USED(CPU使用量,core)
MEMORY_SIZE_USED(内存使用量,MiB)
NETWORK_BANDWIDTH_RECEIVE(网络入带宽,MBps)
NETWORK_BANDWIDTH_TRANSMIT(网络出带宽,MBps)
NETWORK_TRAFFIC_RECEIVE(网络入流量,MiB/s)
NETWORK_TRAFFIC_TRANSMIT(网络出流量,MiB/s)
NETWORK_PACKETS_RECEIVE(网络入包量,Count/s)
NETWORK_PACKETS_TRANSMIT(网络出包量,Count/s)
FS_IOPS_WRITE(磁盘写次数,Count/s)
FS_IOPS_READ(磁盘读次数,Count/s)
FS_SIZE_WRITE(磁盘写大小,MiB/s)
FS_SIZE_READ(磁盘读大小,MiB/s)
示例值:1
Threshold Integer 阈值(整数)
示例值:1
Enabled Boolean 是否启用
示例值:1
DoubleThreshold Float 阈值(小数,优先使用)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

IngressInfo

Ingress 配置

被如下接口引用:DescribeIngress, DescribeIngresses, DescribeRelatedIngresses, ModifyIngress。

名称 类型 必选 描述
EnvironmentId String 环境ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:env-xxx
ClusterNamespace String 环境namespace
示例值:Default
AddressIPVersion String ip version
示例值:IPV4
IngressName String ingress name
示例值:ingress name
Rules Array of IngressRule rules 配置
示例值:rules 配置
ClbId String clb ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:clb-xxx
Tls Array of IngressTls tls 配置
注意:此字段可能返回 null,表示取不到有效值。
示例值:tls 配置
ClusterId String 环境集群ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:cls-xxx
Vip String clb ip
注意:此字段可能返回 null,表示取不到有效值。
示例值:10.10.10.10
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2010-11-11 22:21:11
Mixed Boolean 是否混合 https,默认 false,可选值 true 代表有 https 协议监听
示例值:false
RewriteType String 重定向模式,可选值:
- AUTO(自动重定向http到https)
- NONE(不使用重定向)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Domain String clb 域名
注意:此字段可能返回 null,表示取不到有效值。
示例值:lb-xxx

IngressRule

ingress rule 配置

被如下接口引用:DescribeIngress, DescribeIngresses, DescribeRelatedIngresses, ModifyIngress。

名称 类型 必选 描述
Http IngressRuleValue ingress rule value
示例值:ingress rule value
Host String host 地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx.com
Protocol String 协议,选项为 http, https,默认为 http
示例值:protocol

IngressRuleBackend

Ingress 规则 backend 配置

被如下接口引用:DescribeIngress, DescribeIngresses, DescribeRelatedIngresses, ModifyIngress。

名称 类型 必选 描述
ServiceName String eks service 名
示例值:serviceA
ServicePort Integer eks service 端口
示例值:8080

IngressRulePath

Ingress Rule Path 配置

被如下接口引用:DescribeIngress, DescribeIngresses, DescribeRelatedIngresses, ModifyIngress。

名称 类型 必选 描述
Path String path 信息
示例值:/xxx
Backend IngressRuleBackend backend 配置
示例值:{"ServiceName": "serviceA", "ServicePort": 8080}}

IngressRuleValue

Ingress Rule Value 配置

被如下接口引用:DescribeIngress, DescribeIngresses, DescribeRelatedIngresses, ModifyIngress。

名称 类型 必选 描述
Paths Array of IngressRulePath rule 整体配置
示例值:rulePaths 数组

IngressTls

ingress tls 配置

被如下接口引用:DescribeIngress, DescribeIngresses, DescribeRelatedIngresses, ModifyIngress。

名称 类型 必选 描述
Hosts Array of String host 数组, 空数组表示全部域名的默认证书
示例值:["xx.com", "yyy.com"]
SecretName String secret name,如使用证书,则填空字符串
示例值:secret
CertificateId String SSL Certificate Id
示例值:CertificateId

LogConfig

日志收集配置

被如下接口引用:DescribeLogConfig, DescribePagedLogConfigList, ModifyLogConfig。

名称 类型 描述
Name String 名称
示例值:xxx
InputType String 收集类型,container_stdout 为标准输出;container_file 为文件;
示例值:xxx
LogsetId String 日志集 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx
TopicId String 日志主题 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx
LogType String 日志提取模式,minimalist_log 为单行全文;multiline_log 为多行全文; fullregex_log 为单行正则; multiline_fullregex_log 为多行正则; json_log 为 json;
示例值:xxx
BeginningRegex String 首行正则表达式,当 LogType 为多行全文、多行正则时生效
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx
LogPath String 收集文件目录,当 InputType=container_file 时生效
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx
FilePattern String 收集文件名模式,当 InputType=container_file 时生效
注意:此字段可能返回 null,表示取不到有效值。
示例值:app_*.log
CreateDate String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-05-20T14:42:16Z
ModifyDate String 更新时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:2022-05-20T14:42:16Z
ApplicationId String 应用 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:app-xxx
ApplicationName String 应用名
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx
ExtractRule LogConfigExtractRule 导出规则
注意:此字段可能返回 null,表示取不到有效值。
示例值:{}

LogConfigExtractRule

日志采集的导出规则配置

被如下接口引用:CreateLogConfig, DescribeLogConfig, DescribePagedLogConfigList, ModifyLogConfig。

名称 类型 必选 描述
BeginningRegex String 首行正则表达式
注意:此字段可能返回 null,表示取不到有效值。
示例值:*
Keys Array of String 提取结果
注意:此字段可能返回 null,表示取不到有效值。
示例值:["k1", "k2"]
FilterKeys Array of String 过滤键
注意:此字段可能返回 null,表示取不到有效值。
示例值:["k1"]
FilterRegex Array of String 过滤值
注意:此字段可能返回 null,表示取不到有效值。
示例值:["v1*"]
LogRegex String 日志正则表达式
注意:此字段可能返回 null,表示取不到有效值。
示例值:*
TimeKey String 时间字段
注意:此字段可能返回 null,表示取不到有效值。
示例值:time
TimeFormat String 时间格式
注意:此字段可能返回 null,表示取不到有效值。
示例值:%Y-%m-%d %H:%M:%S
UnMatchUpload String 是否上传解析失败日志
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
UnMatchedKey String 解析失败日志的键名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:LogParseFailure
Backtracking String tracking
注意:此字段可能返回 null,表示取不到有效值。
示例值:""
Delimiter String 分隔符
注意:此字段可能返回 null,表示取不到有效值。
示例值:""

LogConfigListPage

LogConfig 列表结果

被如下接口引用:DescribePagedLogConfigList。

名称 类型 描述
Records Array of LogConfig 记录
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]
ContinueToken String 翻页游标
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxxx

LogOutputConf

日志输出配置

被如下接口引用:DeployApplication, DescribeApplicationInfo, DescribeApplicationsStatus。

名称 类型 必选 描述
OutputType String 日志消费端类型
示例值:cls、kafka
ClsLogsetName String cls日志集
示例值:1
ClsLogTopicId String cls日志主题
示例值:1
ClsLogsetId String cls日志集id
示例值:1
ClsLogTopicName String cls日志名称
示例值:1

MountedSettingConf

挂载配置信息

被如下接口引用:DeployApplication, DescribeApplicationInfo。

名称 类型 必选 描述
ConfigDataName String 配置名称
示例值:1
MountedPath String 挂载路径
示例值:1
Data Array of Pair 配置内容
示例值:[]
SecretDataName String 加密配置名称
示例值:1

NamespaceInfo

Namespace 基础信息

被如下接口引用:DescribeEnvironment。

名称 类型 描述
EnvironmentId String ID 信息
示例值:env-xxx
NamespaceName String 名字(已弃用)
示例值:test
Region String 地域
示例值:ap-shanghai
VpcId String vpc id
示例值:vpc-xxx
SubnetIds Array of String subnet id 数组
示例值:["subnet-xxx"]
Description String 描述
示例值:xxx
CreatedDate String 创建时间
示例值:2012-08-08
EnvironmentName String 环境名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ApmInstanceId String APM 资源 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:instance-xxx
Locked Integer 环境是否上锁,1为上锁,0则未上锁
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Tags Array of Tag 标签
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
EnvType String 环境类型:test、pre、prod
注意:此字段可能返回 null,表示取不到有效值。
示例值:test

NamespacePage

命名空间分页

被如下接口引用:DescribeEnvironments。

名称 类型 描述
Records Array of TemNamespaceInfo 分页内容
示例值:1
Total Integer 总数
示例值:1
Size Integer 条目数
示例值:1
Pages Integer 页数
示例值:1
Current Integer 当前条目
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

NamespaceStatusInfo

命名空间状态

被如下接口引用:DescribeEnvironmentStatus。

名称 类型 必选 描述
EnvironmentId String 命名空间id
示例值:1
EnvironmentName String 命名空间名称
示例值:1
ClusterId String TCB envId | EKS clusterId
示例值:env-xxx | cls-xxx
ClusterStatus String 环境状态
示例值:normal | unavailable
EnvironmentStartingStatus TemEnvironmentStartingStatus 环境启动状态(不在启动中为null)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
EnvironmentStoppingStatus TemEnvironmentStoppingStatus 环境停止状态(不在停止中为null)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

NodeInfo

node信息

被如下接口引用:DescribeApplicationInfo, DescribeApplicationPods, DescribeApplicationsStatus。

名称 类型 描述
Name String node名字
示例值:1
Zone String node可用区
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SubnetId String node子网ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
AvailableIpCount String 可用IP数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Cidr String cidr块
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

Pair

键值对

被如下接口引用:CreateConfigData, DeployApplication, DescribeApplicationInfo, DescribeConfigData, ModifyConfigData。

名称 类型 必选 描述
Key String
示例值:1
Value String
示例值:1
Type String 类型,default 为自定义,reserved 为系统变量,referenced 为引用配置项
注意:此字段可能返回 null,表示取不到有效值。
示例值:default
Config String 配置名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:configName
Secret String 加密配置名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

PortMapping

服务端口映射

被如下接口引用:DeployApplication, DescribeApplicationInfo, DescribeApplicationServiceList, ModifyApplicationService。

名称 类型 必选 描述
Port Integer 端口
示例值:1
TargetPort Integer 映射端口
示例值:1
Protocol String 协议栈 TCP/UDP
示例值:1
ServiceName String k8s service名称
示例值:service123

QueryFilter

查询过滤器

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

名称 类型 必选 描述
Name String 查询字段名称
示例值:1
Value Array of String 查询字段值
示例值:1

RunVersionPod

应用实例

被如下接口引用:DescribeApplicationInfo, DescribeApplicationPods。

名称 类型 描述
Webshell String shell地址
示例值:sss
PodId String pod的id
示例值:aaa
Status String 状态
示例值:Running
CreateTime String 创建时间
示例值:2010-11-11 22:21:11
PodIp String 实例的ip
示例值:127.0.0.1
Zone String 可用区
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
DeployVersion String 部署版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RestartCount Integer 重启次数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Ready Boolean pod是否就绪
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ContainerState String 容器状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
NodeInfo NodeInfo 实例所在节点信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
StartTime String 启动时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Unhealthy Boolean 是否健康
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
UnhealthyWarningMsg String 不健康时的提示信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
VersionId String 版本ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ApplicationName String 应用名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

ServicePage

服务分页

被如下接口引用:DescribeApplications。

名称 类型 必选 描述
Records Array of TemService 条目
示例值:1
Total Integer 总数
示例值:1
Size Integer 条目
示例值:1
Pages Integer 页数
示例值:1
Current Integer 当前条数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

ServicePortMapping

端口映射详细信息结构体

被如下接口引用:CreateApplicationService, DeployApplication, DescribeApplicationInfo, DescribeApplicationServiceList, ModifyApplicationService。

名称 类型 必选 描述
Type String 服务类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:ClusterIP
ServiceName String 服务名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:consumer
ClusterIp String 集群内访问vip
注意:此字段可能返回 null,表示取不到有效值。
示例值:10.0.0.2
ExternalIp String 集群外方位vip
注意:此字段可能返回 null,表示取不到有效值。
示例值:202.0.0.2
SubnetId String 子网id
注意:此字段可能返回 null,表示取不到有效值。
示例值:subnet-123
VpcId String vpc id
注意:此字段可能返回 null,表示取不到有效值。
示例值:vpc-123
LoadBalanceId String LoadBalance Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:clb-123
Yaml String yaml 内容
注意:此字段可能返回 null,表示取不到有效值。
示例值:yaml
Ports Array of Integer 暴露端口列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:[100,2000,3000]
PortMappingItemList Array of ServicePortMappingItem 端口映射数组
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]
ExternalDomain String clb domain
注意:此字段可能返回 null,表示取不到有效值。
示例值:lb-xxxx.com

ServicePortMappingItem

服务端口映射条目

被如下接口引用:CreateApplicationService, DeployApplication, DescribeApplicationInfo, DescribeApplicationServiceList, ModifyApplicationService。

名称 类型 必选 描述
Port Integer 应用访问端口
注意:此字段可能返回 null,表示取不到有效值。
示例值:1000
TargetPort Integer 应用监听端口
注意:此字段可能返回 null,表示取不到有效值。
示例值:2000
Protocol String 协议类型
注意:此字段可能返回 null,表示取不到有效值。
示例值:TCP

ServiceVersionBrief

服务版本信息列表

被如下接口引用:DescribeApplications, DescribeApplicationsStatus, DescribeConfigData。

名称 类型 描述
VersionName String 版本名称
示例值:1
Status String 状态
示例值:1
EnableEs Integer 是否启动弹性 -- 已废弃
示例值:1
CurrentInstances Integer 当前实例
示例值:10
VersionId String version的id
示例值:10
LogOutputConf LogOutputConf 日志输出配置 -- 已废弃
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ExpectedInstances Integer 期望实例
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
DeployMode String 部署方式
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
BuildTaskId String 建构任务ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
EnvironmentId String 环境ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
EnvironmentName String 环境name
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ApplicationId String 服务ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ApplicationName String 服务name
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
UnderDeploying Boolean 是否正在发布中
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
BatchDeployStatus String 分批次部署状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Zones Array of String 可用区
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
NodeInfos Array of NodeInfo 节点信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PodList DescribeRunPodPage 实例信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
WorkloadInfo WorkloadInfo 工作负载信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
CreateDate String 创建日期
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RegionId String 地域id
注意:此字段可能返回 null,表示取不到有效值。
示例值:4

SortType

查询过滤器

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

名称 类型 必选 描述
Key String 排序字段名称
示例值:1
Type Integer 0:升序,1:倒序
示例值:0

StorageConf

存储卷配置

被如下接口引用:DeployApplication, DescribeApplicationInfo。

名称 类型 必选 描述
StorageVolName String 存储卷名称
示例值:1
StorageVolPath String 存储卷路径
示例值:1
StorageVolIp String 存储卷IP
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

StorageMountConf

数据卷挂载信息

被如下接口引用:DeployApplication, DescribeApplicationInfo。

名称 类型 必选 描述
VolumeName String 数据卷名
示例值:1
MountPath String 数据卷绑定路径
示例值:1

Tag

标签

被如下接口引用:CreateApplication, CreateEnvironment, DescribeApplicationInfo, DescribeApplications, DescribeConfigData, DescribeEnvironment, DescribeEnvironments。

名称 类型 必选 描述
TagKey String 标签键
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TagValue String 标签值
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

TemDeployApplicationDetailInfo

分批发布详情

被如下接口引用:DescribeDeployApplicationDetail。

名称 类型 描述
DeployStrategyConf DeployStrategyConf 分批发布策略
注意:此字段可能返回 null,表示取不到有效值。
示例值:{}
StartTime String 开始时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxxxxxxxxxx
EndTime String 结束时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxxxxxxx
Status String 当前状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxxxxxx
BetaBatchDetail DeployServiceBatchDetail beta分批详情
注意:此字段可能返回 null,表示取不到有效值。
示例值:{}
OtherBatchDetail Array of DeployServiceBatchDetail 其他分批详情
注意:此字段可能返回 null,表示取不到有效值。
示例值:[{},{}]
OldVersionPodList DescribeRunPodPage 老版本pod列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:[{pod1}, {pod2}]
CurrentBatchIndex Integer 当前批次id
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ErrorMessage String 错误原因
注意:此字段可能返回 null,表示取不到有效值。
示例值:errormesage
CurrentBatchStatus String 当前批次状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:revert
NewDeployVersion String 新版本version
注意:此字段可能返回 null,表示取不到有效值。
示例值:2018222
OldDeployVersion String 旧版本version
注意:此字段可能返回 null,表示取不到有效值。
示例值:2018221
NewVersionPackageInfo String 包名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:hello-world.jar
NextBatchStartTime Integer 下一批次开始时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:12342423452

TemEnvironmentStartingStatus

环境启动进程(只统计由环境启动操作触发的应用数量)

被如下接口引用:DescribeEnvironmentStatus。

名称 类型 必选 描述
ApplicationNumNeedToStart Integer 需要启动的应用数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
StartedApplicationNum Integer 已经启动的应用数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
StartFailedApplicationNum Integer 启动失败的应用数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

TemEnvironmentStoppingStatus

环境停止进程(只统计由环境停止操作触发的应用数量)

被如下接口引用:DescribeEnvironmentStatus。

名称 类型 必选 描述
ApplicationNumNeedToStop Integer 需要停止的应用数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
StoppedApplicationNum Integer 已经停止的应用数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
StopFailedApplicationNum Integer 停止失败的应用数量
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

TemNamespaceInfo

命名空间对象

被如下接口引用:DescribeEnvironments。

名称 类型 描述
EnvironmentId String 环境id
示例值:1
Channel String 渠道
示例值:1
EnvironmentName String 环境名称
示例值:1
Region String 区域名称
示例值:1
Description String 环境描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Status Integer 状态,1:已销毁;0:正常
示例值:1
Vpc String vpc网络
示例值:1
CreateDate String 创建时间
示例值:1
ModifyDate String 修改时间
示例值:1
Modifier String 修改人
示例值:1
Creator String 创建人
示例值:1
ApplicationNum Integer 应用数
示例值:1
RunInstancesNum Integer 运行实例数
示例值:1
SubnetId String 子网络
示例值:1
ClusterStatus String 环境集群 status
示例值:1
EnableTswTraceService Boolean 是否开启tsw
示例值:true
Locked Integer 环境锁,1为上锁,0则为上锁
示例值:1
AppId String 用户AppId
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Uin String 用户Uin
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SubAccountUin String 用户SubAccountUin
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ClusterId String 集群ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Tags Array of Tag 标签
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
HasAuthority Boolean 资源是否有权限
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
EnvType String 环境类型: test、pre、prod
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
RegionId String 地域码
注意:此字段可能返回 null,表示取不到有效值。
示例值:4

TemService

服务

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

名称 类型 描述
ApplicationId String 主键
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ApplicationName String 服务名
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
Description String 描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
EnvironmentId String 命名空间id
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
CreateDate Timestamp 创建时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
ModifyDate Timestamp 修改时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
Modifier String 修改人
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Creator String 创建者
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RepoType Integer tcr个人版or企业版
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
InstanceId String 企业版实例id
注意:此字段可能返回 null,表示取不到有效值。
示例值:id123
RepoName String 镜像仓库名
注意:此字段可能返回 null,表示取不到有效值。
示例值:tem-ns/repo
CodingLanguage String 编程语言
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
DeployMode String 部署方式
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
EnvironmentName String 环境名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ActiveVersions Array of ServiceVersionBrief 服务当前运行环境的实例信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
EnableTracing Integer 是否启用链路追踪
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Tags Array of Tag 标签
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
HasAuthority Boolean 是否有资源权限
注意:此字段可能返回 null,表示取不到有效值。
示例值:1

TemServiceVersionInfo

版本信息

被如下接口引用:DescribeApplicationInfo。

名称 类型 必选 描述
VersionId String 主键
示例值:1
ApplicationId String 服务id
示例值:1
DeployMode String 部署方式
示例值:1
JdkVersion String jdk版本
示例值:1
Description String 描述
示例值:1
DeployVersion String 部署版本
示例值:1
PublishMode String 发布方式
示例值:1
JvmOpts String 启动参数
示例值:1
InitPodNum Integer 初始实例
示例值:1
CpuSpec Float cpu规格
示例值:1
MemorySpec Float 内存规格
示例值:1
ImgRepo String 镜像路径
示例值:1
ImgName String 镜像名称
示例值:1
ImgVersion String 镜像版本
示例值:1
EsInfo EsInfo 弹性配置
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
EnvConf Array of Pair 环境配置
示例值:1
StorageConfs Array of StorageConf 存储配置
示例值:1
Status String 运行状态
示例值:1
Vpc String 私有网络
示例值:1
SubnetId String 子网网络
示例值:1
CreateDate String 创建时间
示例值:1
ModifyDate String 修改时间
示例值:1
StorageMountConfs Array of StorageMountConf 挂载配置
注意:此字段可能返回 null,表示取不到有效值。
VersionName String 版本名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
LogOutputConf LogOutputConf 日志输出配置
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ApplicationName String 服务名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ApplicationDescription String 服务描述
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
EnvironmentName String 环境名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
EnvironmentId String 环境ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PublicDomain String 公网地址
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
EnablePublicAccess Boolean 是否开通公网访问
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
CurrentInstances Integer 现有的实例
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ExpectedInstances Integer 期望的实例
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
CodingLanguage String 编程语言
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PkgName String 程序包名
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
EsEnable Integer 是否启用弹性伸缩
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
EsStrategy Integer 弹性策略
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
ImageTag String 镜像tag
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
LogEnable Integer 是否启用log
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
MinAliveInstances String 最小实例数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SecurityGroupIds Array of String 安全组
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ImageCommand String 镜像命令
注意:此字段可能返回 null,表示取不到有效值。
示例值:ls
ImageArgs Array of String 镜像命令参数
注意:此字段可能返回 null,表示取不到有效值。
示例值:["-c", "100"]
UseRegistryDefaultConfig Boolean 是否使用默认注册中心配置
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Service EksService eks 访问设置
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SettingConfs Array of MountedSettingConf 挂载配置信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:[]
LogConfs Array of String log path数组信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PostStart String 启动后立即执行的脚本
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PreStop String 停止前执行的脚本
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Liveness HealthCheckConfig 存活探针配置
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Readiness HealthCheckConfig 就绪探针配置
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
HorizontalAutoscaler Array of HorizontalAutoscaler 弹性策略
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
CronHorizontalAutoscaler Array of CronHorizontalAutoscaler 定时弹性策略
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Zones Array of String 应用实际可用区
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
LastDeployDate String 最新部署时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
LastDeploySuccessDate String 最新部署成功时间
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
NodeInfos Array of NodeInfo 应用所在node信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ImageType Integer image类型 -0 为demo -1为正常image
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
EnableTracing Integer 是否启用调用链组件
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
EnableTracingReport Integer 是否开启调用链上报,只有 EnableTracing=1 时生效(参数已弃用)
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RepoType Integer 镜像类型:0-个人镜像、1-企业镜像、2-公有镜像
注意:此字段可能返回 null,表示取不到有效值。
示例值:2
BatchDeployStatus String 分批发布子状态:batch_updating、batch_updating_waiting_confirm
注意:此字段可能返回 null,表示取不到有效值。
示例值:batch_updating
ApmInstanceId String APM 资源 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:apm-xxx
WorkloadInfo WorkloadInfo 工作负载信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:{}
SpeedUp Boolean 是否启用应用加速
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
StartupProbe HealthCheckConfig 启动检测探针配置
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
OsFlavour String 操作系统版本,可选参数:
- ALPINE
- CENTOS
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RepoServer String 镜像仓库server
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
UnderDeploying Boolean 是否正在发布中
注意:此字段可能返回 null,表示取不到有效值。
示例值:true
EnablePrometheusConf EnablePrometheusConf 监控业务指标监控
注意:此字段可能返回 null,表示取不到有效值。
示例值:{}
StoppedManually Boolean 是否为手动停止
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
TcrInstanceId String tcr实例ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
EnableMetrics Integer 1:开始自动metrics采集(open-telemetry);
0:关闭metrics采集;
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
AppId String 用户AppId
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
SubAccountUin String 用户SubAccountUin
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Uin String 用户Uin
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Region String 地域
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
GroupId String 应用分组ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
EnableRegistry Integer 是否启用注册中心
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
AutoscalerList Array of Autoscaler 弹性伸缩数组
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Modifier String 修改人
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Creator String 创建人
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
DeployStrategyConf DeployStrategyConf 部署策略
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PodList DescribeRunPodPage 实例列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ConfEdited Boolean 发布时配置是否有修改
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Tags Array of Tag 标签
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
PreStopEncoded String 是否编码
注意:此字段可能返回 null,表示取不到有效值。
示例值:""
PostStartEncoded String 是否编码
注意:此字段可能返回 null,表示取不到有效值。
示例值:""

UseDefaultRepoParameters

创建应用,创建仓库参数

被如下接口引用:CreateApplication。

名称 类型 描述
EnterpriseInstanceName String 企业版实例名
注意:此字段可能返回 null,表示取不到有效值。
示例值:test
EnterpriseInstanceChargeType Integer 企业版收费类型 0 按量收费 1 包年包月
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
EnterpriseInstanceType String 企业版规格:basic-基础班 ,standard-标准版,premium-高级版
注意:此字段可能返回 null,表示取不到有效值。
示例值:basic

WorkloadInfo

工作负载详情

被如下接口引用:DescribeApplicationInfo, DescribeApplicationsStatus。

名称 类型 描述
ClusterId String 资源 ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:cls-xxx
ApplicationName String 应用名
注意:此字段可能返回 null,表示取不到有效值。
示例值:xxx
VersionName String 版本名称
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ReadyReplicas Integer Ready实例数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Replicas Integer 实例数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
UpdatedReplicas Integer Updated实例数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
UpdatedReadyReplicas Integer UpdatedReady实例数
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
UpdateRevision String 更新版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
CurrentRevision String 当前版本
注意:此字段可能返回 null,表示取不到有效值。
示例值:1