本文介绍ECI资源的数据类型,相关参数仅作为返回参数。

定义 描述
ContainerGroup 容器组,即ECI实例。
ImageRegistryCredential 镜像仓库登录信息。
Volume 数据卷。
Event 事件。
Tag 容器标签。
DNSConfig DNS配置信息。
Container 容器。
ContainerState 容器状态。
VolumeMount 数据卷挂载点。
EnvironmentVar 容器环境变量。
ContainerPort 容器端口。
SecurityContext 实例运行的安全上下文。
ReadinessProbe Readiness探针。
LivenessProbe Liveness探针。

ContainerGroup

名称 类型 描述
RegionId String 实例所属的地域ID。
ZoneId String 实例所属的可用区,空表示由系统选择,默认值:空。
SecurityGroupId String 指定新创建实例所属于的安全组,同一个安全组内的实例之间可以互相访问。
VSwitchId String 指定虚拟交换机ID。
ContainerGroupName String 容器组名称。
ContainerGroupId String 容器组ID。
ImageRegistryCredentials ImageRegistryCredential[] 镜像仓库信息,上限10。
Volumes Volume[] 数据卷信息,上限20。
RestartPolicy String 重启策略。取值范围:
  • Always
  • OnFailure
  • Never
Cpu Float 容器组级别vCPU限制,单位:vCPU。
Memory Float 容器组级别内存限制,单位:GiB。
InitContainers Container[] 初始化容器列表,上限5。
Containers Container[] 容器列表,上限5。
Events Event[] 事件信息,上限50。
DNSConfig DNSConfig DNS配置信息。
InternetIp String 公网IP。
IntranetIP String 内网IP。
Tags Tag[] 实例的标签键值对,上限20。
Status String 返回容器组创建状态。取值范围:
  • Pending
  • Running
  • Succeeded
  • Failed
  • Scheduling
  • ScheduleFailed
CreationTime String 接到请求后的系统创建时间。UTC时间,RFC 3339标准,例如:2018-08-02T15:00:00Z。
SucceededTime String 容器全部成功退出后的时间。UTC时间,RFC 3339标准,例如:2018-08-02T15:00:00Z。
EniInstanceId String ENI ID。
ExpiredTime String 容器由于账号欠费导致运行失败的时间。UTC时间,RFC 3339标准,例如:2018-08-02T15:00:00Z
FailedTime String 容器执行失败的时间。UTC时间,RFC 3339标准,例如:2018-08-02T15:00:00Z

ImageRegistryCredential

名称 类型 是否必须 描述
Server String 不带http://或https://前缀的镜像仓库地址。
UserName String 镜像仓库用户名。
Password String 镜像仓库密码。

Volume

名称 类型 是否必须 描述
Type String 数据卷类型。取值范围:
  • EmptyDirVolume:EmptyDir类型的数据卷,表示空目录。
  • NFSVolume:NFS类型的数据卷,表示网络文件系统。
  • ConfigFileVolume:ConfigFile类型的数据卷,表示配置文件。
  • FlexVolume:使用FlexVolume插件扩展存储类型,支持挂载云盘。
  • HostPathVolume:HostPath类型的数据卷,表示主机节点的文件或目录。
  • DiskVolume(不推荐):云盘数据卷。建议使用FlexVolume挂载云盘。
Name String 数据卷名称。
EmptyDirVolume.Medium String EmptyDirVolume的存储媒介,默认为空,使用node文件系统;支持配置为Memory,表示使用内存。
EmptyDirVolume.SizeLimit String EmptyDirVolume的大小。单位为GiB。
NFSVolume.Server String NFS服务器地址。
NFSVolume.Path String NFSVolume的路径。
NFSVolume.ReadOnly Boolean NFSVolume的读取权限。取值范围:
  • true:只读
  • false:可读可写

默认为false。

ConfigFileVolume.ConfigFileToPath ConfigFileToPath[] ConfigFileVolume信息,即配置文件信息。
ConfigFileVolume.DefaultMode Integer 配置文件默认的权限。
FlexVolume.Driver String 使用FlexVolume插件挂载数据卷时的驱动类型。目前支持alicloud/disk,表示挂载阿里云云盘。
lexVolume.FsType String 挂载的文件系统类型,默认取决于FlexVolume的script。
FlexVolume.Options String FlexVolume对象选项列表。为KV形式,采用JSON传递。
例如通过FlexVolume挂载云盘时,Options表示云盘的配置参数,可配置的参数如下:
  • volumeId:已有云盘ID。
  • volumeSize:云盘大小,单位为GiB。取值范围为20~32768。
  • performanceLevel:云盘性能等级。
  • deleteWithInstance:是否随实例释放,默认为false。
  • encrypted:是否加密云盘,默认为false。
  • kmsKeyId:加密云盘时,云盘使用的KMS密钥ID。
HostPathVolume.Type String HostPath Volume的类型。取值范围:
  • Directory:目录
  • File:文件
HostPathVolume.Path String HostPath Volume在主机上的目录路径。
DiskVolume.DiskId String DiskVolume的ID。
DiskVolume.DiskSize Integer DiskVolume的大小。单位为GiB。
DiskVolume.FsType String DiskVolume的系统类型。

ConfigFileToPath

名称 类型 是否必须 描述
Path String 相对文件路径。
Content String 配置文件内容 (32 KB)。
Mode Integer 目录权限。

Event

名称 类型 描述
Count Integer 事件计数。
FirstTimestamp String 事件起始时间。
LastTimestamp String 事件结束时间。
Message String 事件消息。
Name String 事件的归属对象名。
Type String 事件类型,取值范围:
  • Normal
  • Warning
Reason String 事件名。

Tag

名称 类型 是否必须 描述
Key String 标签键。
Value String 标签值。

DNSConfig

名称 类型 描述
Nameservers String[] DNS服务器IP地址列表。
Searches String[] DNS搜索域列表。
Options Option[] 对象选项列表,每个对象由name和value(可选)构成。

更多信息,请参见DNS

Option

名称 类型 描述
Name String 对象name。
Value String 对象value。

Container

名称 类型 是否必须 描述
Commands String[] 容器启动命令,上限20,单个String,256个字符。
Args String[] 容器启动参数,上限10。
EnvironmentVars EnvironmentVar[] 容器内操作系统的环境变量(键值对),上限100。Key是变量名,Value是变量值 。
Image String 镜像。
Name String 容器名。
Cpu Float vCPU,单位:vCPU。
Memory Float 内存,单位:GiB。
ImagePullPolicy String 镜像拉取策略。取值范围:
  • Always:总是拉取。每次都拉取镜像。
  • IfNotPresent:按需拉取。优先使用本地镜像,本地没有镜像时则拉取镜像。
  • Never:从不拉取。使用本地镜像,不拉取镜像。
VolumeMounts VolumeMount[] 数据卷挂载信息,上限16。
CurrentState ContainerState 当前状态。
PreviousState ContainerState 上一次状态。
RestartCount Integer 重启次数。
WorkingDir String 容器工作目录。
Ports Port[] 暴露端口+协议,上限100。
LivenessProbe LivenessProbe 存活探针。
ReadinessProbe ReadinessProbe 就绪探针。
SecurityContext SecurityContext 实例运行的安全上下文。

ContainerState

仅作为返回参数。

名称 类型 描述
StartTime Timestamp 容器运行开始时间。
State String 容器状态。取值范围:
  • Waiting
  • Running
  • Terminated
DetailStatus String 状态详情。
FinishTime Timestamp 容器运行结束时间。
ExitCode Integer 容器运行退出码。
Reason String 容器状态原因。
Message String 容器状态信息。
Signal Integer 容器状态信号。

VolumeMount

名称 类型 是否必须 描述
Name String 数据卷名称,同Volume中的Name。
MountPath String 挂载目录。容器挂载目录下的内容将被Volume的内容直接覆盖,请谨慎使用。
ReadOnly Boolean 数据卷是否只读。默认值为False。

EnvironmentVar

名称 类型 是否必须 描述
Key String 环境变量名,长度为1~128位,取值范围:[0-9a-zA-Z]以及下划线 '_',不能以数字开头
Value String 环境变量值,长度为0~256位。
FieldRef.FieldPath String 环境变量值引用,目前只支持status.podIP。

Port

名称 类型 描述
Port Integer 端口号。取值范围:1~65535。
Protocol String 协议类型。取值范围:
  • TCP
  • UDP

SecurityContext

名称 类型 描述
Capability Capability 为容器内的进程授予某些特定的权限。目前仅支持配置NET_ADMIN和NET_RAW。其中NET_RAW默认不支持,需提交工单申请。
RunAsUser Int 运行容器的用户ID。该参数配置会覆盖Dockerfile中的USER指令。
ReadOnlyRootFilesystem Bool 容器运行的根文件系统是否为只读。目前仅支持配置为true。

Capability

名称 类型 描述
Adds String[] 目前仅支持配置NET_ADMIN和NET_RAW。其中NET_RAW默认不支持,需提交工单申请。

ReadinessProbe

名称 类型 描述
ReadinessProbe.HttpGet.Path String 使用HTTP请求方式进行健康检查时,HTTP Get请求检测的路径。
ReadinessProbe.HttpGet.Port Integer 使用HTTP请求方式进行健康检查时,HTTP Get请求检测的端口号。
ReadinessProbe.HttpGet.Scheme String 使用HTTP请求方式进行健康检查时,HTTP Get请求对应的协议类型,取值范围:
  • HTTP
  • HTTPS
ReadinessProbe.Exec.Commands String[] 使用命令行方式进行健康检查时,在容器内执行的命令。
ReadinessProbe.TcpSocket.Port Integer 使用TCP Socket方式进行健康检查时,TCP Socket检测的端口。
ReadinessProbe.InitialDelaySeconds Integer 检查开始执行的时间,以容器启动完成为起点计算。
ReadinessProbe.PeriodSeconds Integer 检查执行的周期,默认为10秒,最小为1秒。
ReadinessProbe.SuccessThreshold Integer 从上次检查失败后重新认定检查成功的检查次数阈值(必须是连续成功),默认为1。当前必须为1。
ReadinessProbe.FailureThreshold Integer 从上次检查成功后认定检查失败的检查次数阈值(必须是连续失败),默认为3。
ReadinessProbe.TimeoutSeconds Integer 检查超时的时间,默认为1秒,最小为1秒。

LivenessProbe

名称 类型 描述
LivenessProbe.HttpGet.Path String 使用HTTP请求方式进行健康检查时,HTTP Get请求检测的路径。
LivenessProbe.HttpGet.Port Integer 使用HTTP请求方式进行健康检查时,HTTP Get请求检测的端口号。
LivenessProbe.HttpGet.Scheme String 使用HTTP请求方式进行健康检查时,HTTP Get请求对应的协议类型,取值范围:
  • HTTP
  • HTTPS
LivenessProbe.Exec.Commands String[] 使用命令行方式进行健康检查时,在容器内执行的命令。
LivenessProbe.TcpSocket.Port Integer 使用TCP Socket方式进行健康检查时,TCP Socket检测的端口。
LivenessProbe.InitialDelaySeconds Integer 检查开始执行的时间,以容器启动完成为起点计算。
LivenessProbe.PeriodSeconds Integer 检查执行的周期,默认为10秒,最小为1秒。
LivenessProbe.SuccessThreshold Integer 从上次检查失败后重新认定检查成功的检查次数阈值(必须是连续成功),默认为1。当前必须为1。
LivenessProbe.FailureThreshold Integer 从上次检查成功后认定检查失败的检查次数阈值(必须是连续失败),默认为3。
LivenessProbe.TimeoutSeconds Integer 检查超时的时间,默认为1秒,最小为1秒。