附录

基础类型

Tag

参数	类型	是否必选	描述
tagKey	String	否	标签名 不可重复，有效的tag key必须由字母数字字符、'-'、'.'组成，并且必须以字母数字字符开始和结束。
tagValue	String	否	标签值

Label

参数	类型	是否必选	描述
labelKey	String	否	标签名
labelValue	String	否	标签值

Port

参数	类型	是否必选	描述
name	String	否	端口名
port	Integer	否	端口号
protocol	String	否	协议类型。 取值范围： TCP UDP

HTTPHeader

参数	类型	是否必选	描述
name	String	否	http header name
value	String	否	http header value

Environment

参数	类型	是否必选	描述
key	String	否	环境变量名
value	String	否	环境变量值

ExecAction

参数	类型	是否必选	描述
command	List<String>	否	使用命令行方式进行健康检查时，在容器内执行的命令。

TCPSocketAction

参数	类型	是否必选	描述
port	Integer	否	使用TCP Socket方式进行健康检查时，TCP Socket检测的端口。
host	String	否	使用TCP Socket方式进行健康检查时，TCP Socket检测host。

HTTPGetAction

参数	类型	是否必选	描述
path	String	否	使用HTTP请求方式进行健康检查时，HTTP Get请求检测的路径。
port	Integer	否	使用HTTP请求方式进行健康检查时，HTTP Get请求检测的端口号。
scheme	String	否	使用HTTP请求方式进行健康检查时，HTTP Get请求对应的协议类型，取值范围： HTTP HTTPS
host	String	否	使用HTTP请求方式进行健康检查时，host值。
httpHeaders	List<HTTPHeader>	否	使用HTTP请求方式进行健康检查时，http header。

GRPCAction

参数	类型	是否必选	描述
port	Integer	否	使用GRPC方式进行健康检查时，GRPC检测的端口。
service	String	否	使用GRPC方式进行健康检查时，GRPC检测服务。

实例相关

Probe

参数	类型	是否必选	描述
initialDelaySeconds	Integer	否	检查开始执行的时间，以容器启动完成为起点计算。
timeoutSeconds	Integer	否	检查超时的时间，默认为1秒，最小为1秒。
periodSeconds	Integer	否	检查执行的周期，默认为10秒，最小为1秒。
successThreshold	Integer	否	从上次检查失败后重新认定检查成功的检查次数阈值（必须是连续成功），默认为1。当前必须为1。
failureThreshold	Integer	否	从上次检查成功后认定检查失败的检查次数阈值（必须是连续失败），默认为3。
terminationGracePeriodSeconds	Long	否	程序的缓冲时间，用于处理关闭之前的操作。
httpGet	HTTPGetAction	否	HttpGet检测参数。
tcpSocket	TCPSocketAction	否	TcpSocket检测的端口参数。
exec	ExecAction	否	容器内检测命令参数。
grpc	GRPCAction	否	grpc检测的端口参数。

Container

参数	类型	是否必选	描述
name	String	是	容器名 长度必须介于1和40之间，不可重复，有效的名称必须由字母数字字符、“-”或“.”组成，并且必须以字母数字字符开始和结束。
image	String	是	镜像
memory	Float	否	内存，单位：GiB。 限制该容器最多可使用的内存值，该值不可超过容器实例的总内存值。
cpu	Float	否	CPU，单位：核。 限制容器最多可使用的核数，该值不可超过容器实例的总核数。
gpu	Float	否	容器使用的GPU个数
workingDir	String	否	容器工作目录
imagePullPolicy	String	否	镜像拉取策略。 取值范围：        Always：总是拉取。每次都拉取镜像。        IfNotPresent：按需拉取。优先使用本地镜像，本地没有镜像时则拉取镜像。        Never：从不拉取。使用本地镜像，不拉取镜像。
commands	List<String>	是	容器启动命令
args	List<String>	否	容器启动参数
volumeMounts	List<VolumeMount>	是	数据卷挂载信息
ports	List<Port>	否	容器内端口信息
environmentVars	List<Environment>	否	容器内操作系统的环境变量
livenessProbe	Probe	否	存活探针
readinessProbe	Probe	否	就绪探针
startupProbe	Probe	否	启动探针
stdin	Boolean	否	此容器是否应在容器运行时为标准输入分配缓冲区。 如果未设置，则容器中标准输入的读取值将导致EOF。 默认值：false
stdinOnce	Boolean	否	当标准输入为true时，标准输入流将在多个附加会话中是否保持开启状态。默认值：false
tty	Boolean	否	是否开启交互。 当Command为/bin/bash命令时，需要设置为true。 默认值：false
securityContext	ContainerSecurityContext	否	容器安全上下文信息。

InstanceModel

参数	类型	描述
instanceId	String	实例ID
instanceName	String	实例名称，即容器组名称。
status	String	实例状态。可能值：状态信息不标准。 Pending：启动中 Running：运行中 Succeeded：运行成功 Failed：运行失败
zoneName	String	实例所属的可用区
cpuType	String	cpu类型
gpuType	String	gpu类型
cpu	Float	cpu核数,单位核
memory	Float	memory大小，单位GiB
bandwidthInMbps	Integer	弹性公网IP带宽大小，单位为Mb。
internalIp	String	内网Ip
publicIp	String	外网Ip
createTime	String	接到请求后的系统创建时间。UTC时间，RFC3339标准。
updateTime	String	实例更新时间
deleteTime	String	实例删除时间
restartPolicy	String	容器组的重启策略。取值范围： Never：不重启 Always：始终重启 OnFailure：失败时重启
tags	List<Tag>	实例的标签键值对

InstanceDetailModel

继承InstanceModel，并新增如下字段：

参数	类型	描述
volume	Volume	容器实例存储卷
containers	List<ContainerDetailModel>	业务容器
initContainers	List<ContainerDetailModel>	init容器
securityGroups	List<SecurityGroupModel>	安全组信息
vpc	VpcModel	vpc信息
subnet	SubnetModel	子网信息

ContainerDetailModel

参数	类型	描述
name	String	容器名称
image	String	容器镜像
cpu	Float	cpu数量
gpu	Float	gpu数量
memory	Float	内存大小
workingDir	String	容器工作目录
imagePullPolicy	String	镜像拉取策略
commands	List<String>	容器启动命令
args	List<String>	容器启动参数
ports	List<Port>	容器内端口信息
volumeMounts	List<VolumeMount>	容器存储卷信息
envs	List<Environment>	容器环境变量列表
createTime	String	容器创建时间
updateTime	String	容器更新时间
deleteTime	String	容器删除时间
previousState	ContainerStatus	容器上一次状态
currentState	ContainerStatus	容器当前状态
ready	Boolean	容器是否已通过其就绪探针
restartCount	Integer	重启次数

ContainerStatus

参数	类型	描述
state	String	容器状态。可能值： Waiting：启动中 Running：运行中 Terminated：运行终止
reason	String	容器状态Reason
message	String	容器状态信息
startTime	String	容器运行开始时间
finishTime	String	容器运行结束时间
detailStatus	String	状态详情
exitCode	Integer	容器运行退出码

SecurityGroupModel

参数	类型	描述
securityGroupId	String	安全组 Id
name	String	安全组名称
description	String	安全组描述
vpcId	String	vpc Id

SubnetModel

参数	类型	描述
subnetId	String	子网ID
name	String	子网名称
cidr	String	网段及子网掩码
vpcId	String	vpcID
subnetType	String	子网类型 BCC BBC BCC_NAT BBC_NAT
description	String	subnet描述
createTime	String	创建时间

VpcModel

参数	类型	描述
vpcId	String	vpc Id
name	String	vpc名称
cidr	String	网段及子网掩码
createTime	String	创建时间
description	String	vpc描述
isDefault	Boolean	是否是默认vpc

存储卷相关

Volume

参数	类型	是否必选	描述
nfs	List<NfsVolume>	否	NFS类型数据卷，表示网络文件系统
emptyDir	List<EmptyDirVolume>	否	EmptyDir类型数据卷，表示空目录
configFile	List<ConfigFileVolume>	否	ConfigFile类型数据卷，表示配置文件

NfsVolume

参数	类型	是否必选	描述
name	String	是	NFS服务器名称。
server	String	是	NFS服务器地址。
path	String	是	NFS数据卷路径。
readOnly	Boolean	否	NFS数据卷是否只读，默认为false。

EmptyDirVolume

参数	类型	是否必选	描述
name	String	是	EmptyDirVolume名称。
medium	String	否	EmptyDirVolume的存储媒介，默认为空，使用node文件系统；支持 memory，表示使用内存。
sizeLimit	Float	否	EmptyDirVolume的大小。单位为GiB。

ConfigFileVolume

参数	类型	是否必选	描述
name	String	是	ConfigFileVolume名称
defaultMode	Integer	是	ConfigFileVolume默认的权限。
configFiles	List<ConfigFileDetail>	是	ConfigFile类型的数据卷信息。

ConfigFileDetail

参数	类型	是否必选	描述
path	String	是	ConfigFile文件路径
file	String	是	ConfigFile文件名

VolumeMount

参数	类型	是否必选	描述
name	String	是	数据卷名称
type	String	是	数据卷类型
mountPath	String	是	容器挂载数据卷的目录
readOnly	Boolean	否	数据卷是否只读 默认值：false

镜像相关

ImageRegistryCredential

参数	类型	是否必选	描述
server	String	否	镜像仓库注册地址
userName	String	否	镜像仓库用户名
password	String	否	镜像仓库密码

OriginImage

字段名	类型	是否必选	描述
originImageAddress	String	否	原始镜像地址
originImageVersion	String	否	原始镜像版本

ImageCacheModel

参数	类型	描述
imageCacheId	String	镜像缓存id，全局唯一
originImages	List<String>	用户原始镜像地址
status	String	镜像缓存制作状态。可能状态为：创建成功，创建失败，创建中
progress	Integer	镜像缓存制作进度，范围[0,100]的正整数
expiredTime	TimeStamp	镜像缓存超时回收时间
createdTime	TimeStamp	镜像缓存创建时间
lastestMatchedTime	TimeStamp	镜像缓存最近一次使用时间

安全特性相关

ContainerSecurityContext

参数	类型	是否必选	描述
capabilities	Capabilities	否	安全特性能力
runAsUser	Long	否	运行容器的用户ID
runAsGroup	Long	否	运行容器进程入口点的GID
runAsNonRoot	Boolean	否	容器是否必须以非root用户运行
readOnlyRootFilesystem	Boolean	否	容器运行的根文件系统是否为只读，默认为false

Capabilities

参数	类型	是否必选	描述
add	List<String>	否	启用安全能力项列表
drop	List<String>	否	禁用安全能力项列表