文档中心>API 中心

数据结构

最近更新时间:2021-07-15 08:00:37

我的收藏

CosToken

Cos token

被如下接口引用:CreateCosToken, CreateCosTokenV2。

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

DeployStrategyConf

分批发布策略配置

被如下接口引用:DeployServiceV2。

名称 类型 必选 描述
TotalBatchCount Integer 总分批数
BetaBatchNum Integer beta分批实例数
DeployStrategyType Integer 分批策略:0-全自动,1-全手动,beta分批一定是手动的,这里的策略指定的是剩余批次
BatchInterval Integer 每批暂停间隔

DescribeRunPodPage

版本pod列表

被如下接口引用:DescribeServiceRunPodListV2。

名称 类型 描述
Offset Integer 分页下标
Limit Integer 单页条数
TotalCount Integer 总数
RequestId String 请求id
PodList Array of RunVersionPod 条目

EksService

eks service info

被如下接口引用:DeployServiceV2。

名称 类型 必选 描述
Name String service name
Ports Array of Integer 可用端口
Yaml String yaml 内容
ServiceName String 服务名
注意:此字段可能返回 null,表示取不到有效值。
VersionName String 版本名
注意:此字段可能返回 null,表示取不到有效值。
ClusterIp Array of String 内网ip
注意:此字段可能返回 null,表示取不到有效值。
ExternalIp String 外网ip
注意:此字段可能返回 null,表示取不到有效值。
Type String 访问类型,可选值:
- EXTERNAL(公网访问)
- VPC(vpc内访问)
- CLUSTER(集群内访问)
注意:此字段可能返回 null,表示取不到有效值。
SubnetId String 子网ID,只在类型为vpc访问时才有值
注意:此字段可能返回 null,表示取不到有效值。
LoadBalanceId String 负载均衡ID,只在外网访问和vpc内访问才有值,默认自动创建
注意:此字段可能返回 null,表示取不到有效值。
PortMappings Array of PortMapping 端口映射
注意:此字段可能返回 null,表示取不到有效值。

EsInfo

弹性伸缩配置

被如下接口引用:DeployServiceV2。

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

HealthCheckConfig

健康检查配置

被如下接口引用:DeployServiceV2。

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

IngressInfo

Ingress 配置

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

名称 类型 必选 描述
NamespaceId String tem namespaceId
注意:此字段可能返回 null,表示取不到有效值。
EksNamespace String eks namespace
AddressIPVersion String ip version
Name String ingress name
Rules Array of IngressRule rules 配置
ClbId String clb ID
注意:此字段可能返回 null,表示取不到有效值。
Tls Array of IngressTls tls 配置
注意:此字段可能返回 null,表示取不到有效值。
ClusterId String eks clusterId
注意:此字段可能返回 null,表示取不到有效值。
Vip String clb ip
注意:此字段可能返回 null,表示取不到有效值。
CreateTime String 创建时间
注意:此字段可能返回 null,表示取不到有效值。
Mixed Boolean 是否混合 https,默认 false,可选值 true 代表有 https 协议监听

IngressRule

ingress rule 配置

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

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

IngressRuleBackend

Ingress 规则 backend 配置

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

名称 类型 必选 描述
ServiceName String eks service 名
ServicePort Integer eks service 端口

IngressRulePath

Ingress Rule Path 配置

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

名称 类型 必选 描述
Path String path 信息
Backend IngressRuleBackend backend 配置

IngressRuleValue

Ingress Rule Value 配置

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

名称 类型 必选 描述
Paths Array of IngressRulePath rule 整体配置

IngressTls

ingress tls 配置

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

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

LogOutputConf

日志输出配置

被如下接口引用:DeployServiceV2。

名称 类型 必选 描述
OutputType String 日志消费端类型
ClsLogsetName String cls日志集
ClsLogTopicId String cls日志主题
ClsLogsetId String cls日志集id
ClsLogTopicName String cls日志名称

MountedSettingConf

挂载配置信息

被如下接口引用:DeployServiceV2。

名称 类型 必选 描述
ConfigDataName String 配置名称
MountedPath String 挂载路径
Data Array of Pair 配置内容

NamespacePage

命名空间分页

被如下接口引用:DescribeNamespaces。

名称 类型 描述
Records Array of TemNamespaceInfo 分页内容
Total Integer 总数
Size Integer 条目数
Pages Integer 页数

Pair

键值对

被如下接口引用:DeployServiceV2。

名称 类型 必选 描述
Key String
Value String

PortMapping

服务端口映射

被如下接口引用:DeployServiceV2。

名称 类型 必选 描述
Port Integer 端口
TargetPort Integer 映射端口
Protocol String 协议栈 TCP/UDP

RunVersionPod

版本pod

被如下接口引用:DescribeServiceRunPodListV2。

名称 类型 描述
Webshell String shell地址
PodId String pod的id
Status String 状态
CreateTime String 创建时间
PodIp String 实例的ip
Zone String 可用区
注意:此字段可能返回 null,表示取不到有效值。
DeployVersion String 部署版本
注意:此字段可能返回 null,表示取不到有效值。
RestartCount Integer 重启次数
注意:此字段可能返回 null,表示取不到有效值。

StorageConf

存储卷配置

被如下接口引用:DeployServiceV2。

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

StorageMountConf

数据卷挂载信息

被如下接口引用:DeployServiceV2。

名称 类型 必选 描述
VolumeName String 数据卷名
MountPath String 数据卷绑定路径

TemNamespaceInfo

命名空间对象

被如下接口引用:DescribeNamespaces。

名称 类型 描述
NamespaceId String 命名空间id
Channel String 渠道
NamespaceName String 命名空间名称
Region String 区域名称
Description String 命名空间描述
注意:此字段可能返回 null,表示取不到有效值。
Status Integer 状态,1:已销毁;0:正常
Vpc String vpc网络
CreateDate String 创建时间
ModifyDate String 修改时间
Modifier String 修改人
Creator String 创建人
ServiceNum Integer 服务数
RunInstancesNum Integer 运行实例数
SubnetId String 子网络
TcbEnvStatus String tcb环境状态
ClusterStatus String eks cluster status
EnableTswTraceService Boolean 是否开启tsw