文档

CreateContainerGroup - 创建一个容器组

更新时间:

调用CreateContainerGroup创建一个ECI实例(即容器组)。

接口说明

调用 CreateContainerGroup 创建 ECI 实例时,系统将自动为您创建一个服务关联角色 AliyunServiceRoleForECI,用于访问 ECS、VPC 等相关云服务。更多信息,请参见弹性容器实例服务关联角色

创建 ECI 实例时,您可以根据需要配置实例、镜像、存储等相关功能。各功能涉及的参数及其说明,请参见以下功能文档:

实例

ECI 支持以下两种方式创建实例:

以下功能两种创建方式均支持:

镜像

网络

存储

容器配置

日志与运维

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
eci:CreateContainerGroupWrite
  • ContainerGroup
    acs:eci:{#regionId}:{#accountId}:containergroup/*
  • eci:tag

请求参数

名称类型必填描述示例值
RegionIdstring

地域 ID。

cn-hangzhou
ZoneIdstring

实例所属的可用区。如果取值为空,则表示由系统选择。

默认值为空。

cn-hangzhou-b
SecurityGroupIdstring

实例所属的安全组 ID。同一个安全组内的实例之间可以互相访问。

如果没有指定安全组,系统将自动使用您选择的地域下的默认安全组,您需要确保该安全组的入方向规则中包含容器需要暴露的协议和端口。如果您在该地域下没有默认安全组,系统将自动创建一个默认安全组,并将您声明的容器协议和端口添加到该安全组的入方向规则中。

sg-uf66jeqopgqa9hdn****
VSwitchIdstring

实例所属的交换机 ID。支持指定多个交换机 ID(单次最多 10 个),各交换机 ID 之间可以用半角逗号(,)进行分割,例如vsw-***,vsw-***

如果没有指定交换机,系统将自动使用您选择的地域下的默认 VPC 下的默认交换机,如果您在该地域下没有默认 VPC 和默认交换机,系统将自动创建一个默认 VPC 和一个默认交换机。

说明 交换机网段内的 IP 个数决定了该交换机下最大可以创建的 ECI 实例数量,请务必提前规划好网段。
vsw-bp1xpiowfm5vo8o3c****,vsw-bp1rkyjgr1xwoho6k****
ContainerGroupNamestring

ECI 实例名称,即容器组名称。格式要求如下:

  • 长度为 2~128 个字符。
  • 支持英文小写字母、数字或者短划线(-),不能以短划线开头或者结尾。
nginx-test
RestartPolicystring

实例重启策略。取值范围:

  • Always:总是重启
  • Never:从不重启
  • OnFailure:失败时重启

默认值:Always。

Always
EipInstanceIdstring

弹性公网 IP ID。

eip-uf66jeqopgqa9hdn****
Cpufloat

实例级别 vCPU 大小。单位:核。

1.0
Memoryfloat

实例级别内存大小。单位:GiB。

2.0
ResourceGroupIdstring

资源组 ID。

rg-uf66jeqopgqa9hdn****
DnsPolicystring

DNS 策略。取值范围:

  • None:使用 DnsConfig 字段设置的 DNS。
  • Default:继承运行环境的 DNS 设置。
Default
ClientTokenstring

保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。只支持 ASCII 字符,且不能超过 64 个字符。更多详情,请参阅如何保证幂等性

123e4567-xxxx-12d3-xxxx-426655440000
InstanceTypestring

指定的 ECS 实例规格,支持多规格。更多信息,请参见指定 ECS 规格创建实例

ecs.c5.xlarge
ImageSnapshotIdstring

镜像缓存 ID。更多信息,请参见使用镜像缓存加速创建实例

imc-2zebxkiifuyzzlhl****
RamRoleNamestring

实例 RAM 角色名称。ECI 与 ECS 共用实例 RAM 角色,更多信息,请参见通过 API 使用实例 RAM 角色

RamTestRole
TerminationGracePeriodSecondslong

程序的缓冲时间,用于处理关闭之前的操作。单位为秒。

60
AutoMatchImageCacheboolean

是否自动匹配镜像缓存。默认为 false。

false
Ipv6AddressCountinteger

IPv6 地址数。固定为 1,即一个 ECI 实例支持绑定一个 IPv6 地址。

1
ActiveDeadlineSecondslong

ECI 实例的有效期限,超出该时间后,实例会被强制退出。单位为秒。

1000
SpotStrategystring

实例的抢占策略。取值范围:

  • NoSpot:正常按量付费实例。
  • SpotWithPriceLimit:设置上限价格的抢占式实例。
  • SpotAsPriceGo:系统自动出价,跟随当前市场实际价格的抢占式实例。

默认值:NoSpot。

SpotWithPriceLimit
SpotPriceLimitfloat

设置抢占式实例的每小时最高价格,最多精确到小数点后 3 位。

当 SpotStrategy 取值为 SpotWithPriceLimit 时,必须设置 SpotPriceLimit。

0.025
ScheduleStrategystring

配置了多可用区(通过 VSwitchId 参数指定多个交换机)时,ECI 实例的调度策略。取值范围:

  • VSwitchOrdered:按顺序调度
  • VSwitchRandom:随机调度

更多信息,请参见多可用区创建实例

VSwitchOrdered
CorePatternstring

自定义设置 coredump 生成的 core 文件的保存目录。更多信息,请参见设置 core 文件保存到数据卷

说明 配置的路径不能以|开头,即不能通过 Core dump 来配置可执行程序。
/xx/xx/core
ShareProcessNamespaceboolean

是否使用共享命名空间。默认为 false。

false
AutoCreateEipboolean

是否自动创建一个 EIP,并绑定到 ECI 实例上。

true
EipBandwidthinteger

EIP 的带宽,默认为 5 Mbps。
当 AutoCreateEip 取值为 true 时,可以设置该参数。

5
EipISPstring

设置 EIP 的线路类型。取值范围:

  • BGP(默认值):BGP(多线)线路
  • BGP_PRO:BGP(多线)精品线路
BGP
EipCommonBandwidthPackagestring

绑定已有的共享带宽包。

cbwp-2zeukbj916scmj51m****
HostNamestring

主机名称。

test
IngressBandwidthlong

入方向带宽限制。单位:Byte。

1024000
EgressBandwidthlong

出方向带宽限制。单位:Byte。

1024000
CpuOptionsCoreinteger

CPU 物理核心数。仅部分规格支持自定义设置。

2
CpuOptionsThreadsPerCoreinteger

每核线程数。仅部分规格支持自定义设置。配置为 1 时表示关闭超线程。

2
CpuOptionsNumastring

该参数暂不支持设置。

1
EphemeralStorageinteger

增加的临时存储空间大小。单位:GiB。
更多信息,请参见自定义临时存储空间大小

20
Tagobject []

标签列表。最多可以绑定 20 个。更多信息,请参见使用标签管理实例

Keystring

标签键。如果传入该值,则不允许为空字符串,且不允许重复。最多支持 64 个字符,不能以aliyunacs:开头,不能包含http://或者https://

version
Valuestring

标签值。如果传入该值,可以为空字符串。最多支持 128 个字符,不能以acs:开头,不能包含http://或者https://

3
ImageRegistryCredentialobject []

镜像仓库信息。

Passwordstring

镜像仓库密码。

yourpassword
Serverstring

镜像仓库注册地址。

registry-vpc.cn-shanghai.aliyuncs.com
UserNamestring

镜像仓库用户名。

yourusername
Containerobject []

容器信息。

ReadinessProbe.TimeoutSecondsinteger

检查超时的时间,默认为 1 秒,最小为 1 秒。

1
ReadinessProbe.SuccessThresholdinteger

从上次检查失败后重新认定检查成功的检查次数阈值(必须是连续成功),默认为 1。当前必须为 1。

1
SecurityContext.Capability.Addarray

为容器内的进程授予某些特定的权限。目前仅支持配置为 NET_ADMIN 和 NET_RAW。

说明 NET_RAW 默认不支持,需提交工单申请。
string

为容器内的进程授予某些特定的权限。目前仅支持配置为 NET_ADMIN 和 NET_RAW。

说明 NET_RAW 默认不支持,需提交工单申请。
NET_ADMIN
ReadinessProbe.TcpSocket.Portinteger

使用 TCP Socket 方式进行健康检查时,TCP Socket 检测的端口。

说明 设置 ReadinessProbe 相关参数时,HttpGet、Exec 和 TcpSocket 这三种检查方式,只能选择其中一种。
8000
ReadinessProbe.HttpGet.Schemestring

使用 HTTP 请求方式进行健康检查时,HTTP Get 请求对应的协议类型,取值范围:

  • HTTP
  • HTTPS
说明 设置 ReadinessProbe 相关参数时,HttpGet、Exec 和 TcpSocket 这三种检查方式,只能选择其中一种。
HTTP
LivenessProbe.PeriodSecondsinteger

检查执行的周期,默认为 10 秒,最小为 1 秒。

5
SecurityContext.ReadOnlyRootFilesystemboolean

容器运行的根文件系统是否为只读,目前仅支持配置为 true。

true
EnvironmentVarobject []

容器的环境变量值。

Keystring

环境变量名。长度为 1~128 位。格式要求:[0-9a-zA-Z],以及下划线,不能以数字开头。

PATH
Valuestring

环境变量值。长度为 0~256 位。

/usr/local/bin
FieldRef.FieldPathstring

环境变量值引用。目前只支持配置为 status.podIP。

status.podIP
LivenessProbe.TcpSocket.Portinteger

使用 TCP Socket 方式进行健康检查时,TCP Socket 检测的端口。

说明 设置 LivenessProbe 相关参数时,HttpGet、Exec 和 TcpSocket 这三种检查方式,只能选择其中一种。
8080
Ttyboolean

是否开启交互。默认为 false。

当 Command 为/bin/bash 命令时,需要设置为 true。

false
WorkingDirstring

容器工作目录。

/usr/local/
Argarray

容器启动命令对应的参数。最多 10 个。

string

容器启动命令对应的参数。最多 10 个。

100
Stdinboolean

此容器是否应在容器运行时为标准输入分配缓冲区。如果未设置,则容器中标准输入的读取值将导致 EOF。默认为 false。

false
LivenessProbe.InitialDelaySecondsinteger

检查开始执行的时间,以容器启动完成为起点计算。

5
VolumeMountobject []

数据卷信息。

MountPropagationstring

数据卷的挂载传播设置。挂载传播允许将 Container 挂载的卷共享到同一 Pod 中的其他 Container,甚至可以共享到同一节点上的其他 Pod。取值范围:

  • None:该卷不感知任何后续在此卷或其子目录上执行的挂载操作。

  • HostToContainer:该卷将会感知到后续在此卷或其子目录上的挂载操作。

  • Bidirectional:和 HostToContainer 类似,能感知挂载操作。另外,该卷将被传播回主机和使用同一卷的所有 Pod 的所有容器。

默认值:None

None
MountPathstring

容器挂载数据卷的目录。

说明 容器挂载目录下的内容会被 Volume 的内容直接覆盖,请谨慎使用。
/pod/data
ReadOnlyboolean

数据卷是否只读。默认为 false。

false
SubPathstring

数据卷子路径。

data2/
Namestring

数据卷名称。同 Volume 中的 Name。

default-volume1
ImagePullPolicystring

镜像拉取策略。取值范围:

  • Always:总是拉取。每次都拉取镜像。
  • IfNotPresent:按需拉取。优先使用本地镜像,本地没有镜像时则拉取镜像。
  • Never:从不拉取。使用本地镜像,不拉取镜像。
Always
StdinOnceboolean

当标准输入为 true 时,标准输入流将在多个附加会话中是否保持开启状态。
如果 StdinOnce 设为 true,标准输入在容器开启时被打开,在首个客户端附加到标准输入之前都为空,然后会一直保持开启状态,接收数据,直到客户端连接断开,此时标准输入被关闭,在容器重启前一直保持关闭状态。

false
LifecyclePreStopHandlerTcpSocketPortinteger

使用 TCPSocket 方式设置 preStop 回调函数时,TCP Socket 检测的端口。

90
LifecyclePostStartHandlerHttpGetSchemestring

使用 HTTP 请求方式设置 postStart 回调函数时,HTTP Get 请求对应的协议类型,取值范围:

  • HTTP
  • HTTPS
HTTPS
ReadinessProbe.PeriodSecondsinteger

检查执行的周期,默认为 10 秒,最小为 1 秒。

3
LivenessProbe.SuccessThresholdinteger

从上次检查失败后重新认定检查成功的检查次数阈值(必须是连续成功),默认为 1。当前必须为 1。

1
Commandarray

容器启动命令。最多 20 个。每个命令最多包含 256 个字符。

string

容器启动命令。最多 20 个。每个命令最多包含 256 个字符。

sleep
LifecyclePostStartHandlerHttpGetHoststring

使用 HTTP 请求方式设置 postStart 回调函数时,接收 HTTP Get 请求的主机地址。

10.0.XX.XX
TerminationMessagePolicystring

消息通知策略,默认为空,目前仅支持 mns 队列消息通知。

FallbackToLogsOnError
ReadinessProbe.HttpGet.Pathstring

使用 HTTP 请求方式进行健康检查时,HTTP Get 请求检测的路径。

说明 设置 ReadinessProbe 相关参数时,HttpGet、Exec 和 TcpSocket 这三种检查方式,只能选择其中一种。
/healthz
LivenessProbe.Exec.Commandarray

使用命令行方式进行健康检查时,在容器内执行的命令。

说明 设置 LivenessProbe 相关参数时,HttpGet、Exec 和 TcpSocket 这三种检查方式,只能选择其中一种。
string

使用命令行方式进行健康检查时,在容器内执行的命令。

cat /tmp/healthy
LifecyclePostStartHandlerTcpSocketPortinteger

使用 TCPSocket 方式设置 postStart 回调函数时,TCP Socket 检测的端口。

80
LifecyclePostStartHandlerHttpGetPathstring

使用 HTTP 请求方式设置 postStart 回调函数时,HTTP Get 请求检测的路径。

/healthyz
LifecyclePostStartHandlerExecarray

使用命令行方式设置 postStart 回调函数时,在容器内执行的命令。

string

使用命令行方式设置 postStart 回调函数时,在容器内执行的命令。

["/bin/sh", "-c", "echo Hello from the postStart handler > /usr/share/message"]
LifecyclePreStopHandlerHttpGetPathstring

使用 HTTP 请求方式设置 preStop 回调函数时,HTTP Get 请求检测的路径。

/healthyz
Portobject []

端口号。

Protocolstring

协议类型。取值范围:

  • TCP
  • UDP
TCP
Portinteger

端口号。取值范围:1~65535。

80
TerminationMessagePathstring

容器的报错地址。

/tmp/termination-log
LifecyclePreStopHandlerHttpGetSchemestring

使用 HTTP 请求方式设置 preStop 回调函数时,HTTP Get 请求对应的协议类型,取值范围:

  • HTTP
  • HTTPS
HTTP
LivenessProbe.HttpGet.Schemestring

使用 HTTP 请求方式进行健康检查时,HTTP Get 请求对应的协议类型,取值范围:

  • HTTP
  • HTTPS
说明 设置 LivenessProbe 相关参数时,HttpGet、Exec 和 TcpSocket 这三种检查方式,只能选择其中一种。
HTTP
ReadinessProbe.HttpGet.Portinteger

使用 HTTP 请求方式进行健康检查时,HTTP Get 请求检测的端口号。

说明 设置 ReadinessProbe 相关参数时,HttpGet、Exec 和 TcpSocket 这三种检查方式,只能选择其中一种。
8080
LifecyclePostStartHandlerTcpSocketHoststring

使用 TCP Socket 方式设置 postStart 回调函数时,TCP Socket 检测的主机地址。

10.0.XX.XX
Gpuinteger

指定容器使用的 GPU 个数。

1
ReadinessProbe.InitialDelaySecondsinteger

检查开始执行的时间,以容器启动完成为起点计算。

3
LifecyclePreStopHandlerExecarray

使用命令行方式设置 preStop 回调函数时,在容器内执行的命令。

string

使用命令行方式设置 preStop 回调函数时,在容器内执行的命令。

["/bin/sh", "-c","echo Hello from the preStop handler > /usr/share/message"]
Memoryfloat

容器的内存大小。单位:GiB。

0.5
Namestring

容器名称。

nginx
LifecyclePreStopHandlerHttpGetHoststring

使用 HTTP 请求方式设置 preStop 回调函数时,接收 HTTP Get 请求的主机地址。

10.0.XX.XX
LifecyclePreStopHandlerTcpSocketHoststring

使用 TCP Socket 方式设置 preStop 回调函数时,TCP Socket 检测的主机地址。

10.0.XX.XX
Imagestring

容器镜像。

registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:latest
LifecyclePreStopHandlerHttpGetPortinteger

使用 HTTP 请求方式设置 preStop 回调函数时,HTTP Get 请求检测的端口号。

88
LivenessProbe.FailureThresholdinteger

从上次检查成功后认定检查失败的检查次数阈值(必须是连续失败),默认为 3。

3
ReadinessProbe.Exec.Commandarray

使用命令行方式进行健康检查时,在容器内执行的命令。

说明 设置 ReadinessProbe 相关参数时,HttpGet、Exec 和 TcpSocket 这三种检查方式,只能选择其中一种。
string

使用命令行方式进行健康检查时,在容器内执行的命令。

cat /tmp/healthy
LifecyclePreStopHandlerHttpGetHttpHeaderobject []

生成的 HTTP 请求头参数。

Valuestring

使用 HTTP 请求方式设置 preStop 回调函数时,HTTP Get 请求头中自定义设置的字段值。

test-preStop
Namestring

使用 HTTP 请求方式设置 preStop 回调函数时,HTTP Get 请求头中自定义设置的字段值。

Xiao-Custom-Header
ReadinessProbe.FailureThresholdinteger

从上次检查成功后认定检查失败的检查次数阈值(必须是连续失败),默认为 3。

3
Cpufloat

容器的 vCPU 大小。单位:核。

0.25
LivenessProbe.HttpGet.Portinteger

使用 HTTP 请求方式进行健康检查时,HTTP Get 请求检测的端口号。

说明 设置 LivenessProbe 相关参数时,HttpGet、Exec 和 TcpSocket 这三种检查方式,只能选择其中一种。
8888
LivenessProbe.HttpGet.Pathstring

使用 HTTP 请求方式进行健康检查时,HTTP Get 请求检测的路径。

说明 设置 LivenessProbe 相关参数时,HttpGet、Exec 和 TcpSocket 这三种检查方式,只能选择其中一种。
/healthz
LivenessProbe.TimeoutSecondsinteger

检查超时的时间,默认为 1 秒,最小为 1 秒。

1
SecurityContext.RunAsUserlong

设置运行容器的用户 ID。

1000
LifecyclePostStartHandlerHttpGetPortinteger

使用 HTTP 请求方式设置 postStart 回调函数时,HTTP Get 请求检查的端口号。

5050
LifecyclePostStartHandlerHttpGetHttpHeaderobject []

生成的 HTTP 请求头参数。

Valuestring

使用 HTTP 请求方式设置 postStart 回调函数时,HTTP Get 请求头中自定义设置的字段值。

test-postStart
Namestring

使用 HTTP 请求方式设置 postStart 回调函数时,HTTP Get 请求头中自定义设置的字段名。

Xiao-Custom-Header
EnvironmentVarHideboolean

查询 ECI 实例详情时,是否隐藏环境变量信息。取值范围:

  • false(默认值):查询 ECI 实例详情时,不隐藏环境变量信息。
  • true:查询 ECI 实例详情时,不返回环境变量信息。在环境变量带有敏感信息时,配置为 true 可以提高安全性。
false
SecurityContextRunAsGrouplong

设置运行容器的用户组。

3000
SecurityContextRunAsNonRootboolean

取值为 true 表示以非 root 模式运行容器。

true
Volumeobject []

数据卷信息。

Typestring

数据卷类型。取值范围:

  • EmptyDirVolume:EmptyDir 类型的数据卷,表示空目录。
  • NFSVolume:NFS 类型的数据卷,表示网络文件系统。
  • ConfigFileVolume:ConfigFile 类型的数据卷,表示配置文件。
  • FlexVolume:使用 FlexVolume 插件扩展存储类型,支持挂载云盘。
  • HostPathVolume:HostPath 类型的数据卷,表示主机节点的文件或目录。该类型仅对白名单用户开放使用。
  • DiskVolume(不推荐):云盘数据卷。建议使用 FlexVolume 挂载云盘。
ConfigFileVolume
DiskVolume.DiskSizeinteger

DiskVolume 的大小。单位为 GiB。

15
NFSVolume.Pathstring

NFS 数据卷路径。

/share
DiskVolume.FsTypestring

DiskVolume 的系统类型。

xfs
FlexVolume.FsTypestring

挂载的文件系统类型,默认取决于 FlexVolume 的 script。

ext4
HostPathVolume.Typestring

HostPath Volume 的类型。取值范围:

  • Directory:目录。
  • File:文件。
说明 HostPath Volume 仅对白名单用户开放使用。
Directory
ConfigFileVolume.DefaultModeinteger

ConfigFileVolume 默认的权限。

0644
NFSVolume.ReadOnlyboolean

NFS 数据卷是否只读。默认为 false。

false
ConfigFileVolume.ConfigFileToPathobject []

ConfigFile 类型的数据卷信息。

Pathstring

相对于挂载目录,配置文件所在的相对文件路径。

test/config-test.cnf
Modeinteger

配置文件的权限,如果没有设置,则采用 ConfigFileVolume.DefaultMode 的值。采用四位八进制数表示,例如 0644 表示权限为 rw-r–r--,即用户权限为 rw-,用户所在组权限为 r--,其他用户权限为 r--。

权限说明如下:

  • ---:没有任何权限,八进制值为 0。
  • --x:只有执行权限,八进制值为 1。
  • -w-:只有写入权限,八进制值为 2。
  • -wx:有写入和执行权限,八进制值为 3。
  • r--:只有读取权限,八进制值为 4。
  • r-x:有读取和执行权限,八进制值为 5。
  • rw-:有读取和写入权限,八进制值为 6。
  • rwx:具有读取、写入和执行权限,八进制值为 7。
0644
Contentstring

配置文件内容,需要将内容进行 Base64 编码。
配置文件不能大于 32 KB。

bGl1bWk=
HostPathVolume.Pathstring

HostPath Volume 在主机上的目录路径。

/pod/data
FlexVolume.Optionsstring

FlexVolume 对象选项列表。为 KV 形式,采用 JSON 传递。

例如通过 FlexVolume 挂载云盘时,Options 表示云盘的配置参数,可配置的参数如下:

  • volumeId:已有云盘 ID。
  • volumeSize:云盘大小,单位为 GiB。取值范围为 20~32768。
  • performanceLevel:云盘性能等级。更多信息,请参见云盘性能等级
  • deleteWithInstance:是否随实例释放,默认为 false。
  • encrypted:是否加密云盘,默认为 false。更多信息,请参见加密概述
  • kmsKeyId:加密云盘时,云盘使用的 KMS 密钥 ID。
{"volumeId":"d-2zehdahrwoa7srg****","performanceLevel": "PL2"}
FlexVolume.Driverstring

使用 FlexVolume 插件挂载数据卷时的驱动类型。取值范围如下:

  • alicloud/disk:挂载云盘。
  • alicloud/nas:挂载 NAS。
  • alicloud/oss:挂载 OSS。
alicloud/disk
NFSVolume.Serverstring

NFS 服务器地址。

3f9cd4a596-naw76.cn-shanghai.nas.aliyuncs.com
DiskVolume.DiskIdstring

DiskVolume 的 ID。

d-xx
Namestring

数据卷名称。

default-volume1
EmptyDirVolume.Mediumstring

EmptyDirVolume 的存储媒介,默认为空,使用 node 文件系统;支持 memory,表示使用内存。

memory
EmptyDirVolume.SizeLimitstring

EmptyDirVolume 的大小。单位为 GiB。

2
InitContainerobject []

Init 容器列表。

SecurityContext.Capability.Addarray

为容器内的进程授予某些特定的权限。目前仅支持配置为 NET_ADMIN 和 NET_RAW。

说明 NET_RAW 默认不支持,需提交工单申请。
string

为容器内的进程授予某些特定的权限。目前仅支持配置为 NET_ADMIN 和 NET_RAW。

说明 NET_RAW 默认不支持,需提交工单申请。
NET_ADMIN
Imagestring

容器使用的镜像。

nginx
VolumeMountobject []

挂载数据卷信息列表。

MountPropagationstring

数据卷的挂载传播设置。挂载传播允许将 Container 挂载的卷共享到同一 Pod 中的其他 Container,甚至可以共享到同一节点上的其他 Pod。取值范围:

  • None:该卷不感知任何后续在此卷或其子目录上执行的挂载操作。

  • HostToContainer:该卷将会感知到后续在此卷或其子目录上的挂载操作。

  • Bidirectional:和 HostToContainer 类似,能感知挂载操作。另外,该卷将被传播回主机和使用同一卷的所有 Pod 的所有容器。

默认值:None

None
MountPathstring

挂载目录,容器的挂载目录下的内容被 volume 的内容直接覆盖,所以要慎用。

/usr/share/
ReadOnlyboolean

挂载路径是否只读。默认为 false。

false
SubPathstring

数据卷下的子目录,方便 Pod 将同一个 Volume 下不同目录挂载到容器不同目录。

/usr/sub/
Namestring

挂载数据卷的名称。

test-empty
Portobject []

init 容器端口号。

Protocolstring

协议类型。取值范围:

  • TCP
  • UDP
TCP
Portinteger

端口号。取值范围:1~65535。

8888
SecurityContext.ReadOnlyRootFilesystemboolean

容器运行的根文件系统是否为只读。目前仅支持配置为 true。

true
TerminationMessagePathstring

容器退出的消息来源。当容器退出时,从指定的终止消息文件中检索终止消息。

/tmp/termination-log
EnvironmentVarobject []

容器的环境变量信息列表。

Keystring

环境变量名。长度为 1~128 位。格式要求:[0-9a-zA-Z],以及下划线,不能以数字开头。

Path
Valuestring

环境变量值。长度为 0~256 位。

/usr/bin/
FieldRef.FieldPathstring

环境变量值引用。目前只支持配置为 status.podIP。

status.podIP
ImagePullPolicystring

镜像拉取策略。取值范围:

  • Always:总是拉取。每次都拉取镜像。
  • IfNotPresent:按需拉取。优先使用本地镜像,本地没有镜像时则拉取镜像。
  • Never:从不拉取。使用本地镜像,不拉取镜像。
Always
WorkingDirstring

工作目录。

/usr/local
Cpufloat

容器的 vCPU 大小。单位:核。

0.5
Argarray

容器启动参数。

string

容器启动参数。

10
Commandarray

容器启动指令。

string

容器启动指令。

sleep
Gpuinteger

指定容器使用的 GPU 个数。

1
SecurityContext.RunAsUserlong

设置运行容器的用户 ID。

587
Memoryfloat

容器的内存大小。单位:GiB。

1.0
TerminationMessagePolicystring

挂载信息,默认为空。

*****
Namestring

容器名称。

test-init
DnsConfig.NameServerarray

DNS 服务器的 IP 地址列表。

string

DNS 服务器的 IP 地址列表。

172.10.*.**
DnsConfig.Searcharray

DNS 搜索域列表。

string

DNS 搜索域列表。

svc.local.kubernetes
DnsConfig.Optionobject []

对象的选项列表。

Valuestring

对象的 Value。

value
Namestring

对象的 Name。

name
HostAliaseobject []

添加一个 ECI 的别名。

Ipstring

添加 IP。

1.1.1.1
Hostnamearray

添加主机名。

string

添加主机名。

hehe.com
SecurityContext.Sysctlobject []

通过安全上下文修改安全 sysctl 参数。更多信息,请参见配置 Security Context

Valuestring

通过安全上下文修改 sysctl 参数时,安全 sysctl 参数的取值。

65536
Namestring

通过安全上下文修改 sysctl 参数时,安全 sysctl 参数的名称。取值范围:

  • net.ipv4.ping_group_range
  • net.ipv4.ip_unprivileged_port_start
net.ipv4.ping_group_range
HostSecurityContext.Sysctlobject []

通过安全上下文修改非安全 sysctl 参数。更多信息,请参见配置 Security Context

Valuestring

通过安全上下文修改 sysctl 参数时,非安全 sysctl 参数的取值。

65536
Namestring

通过安全上下文修改 sysctl 参数时,非安全 sysctl 参数的名称。取值范围:

  • kernel.shm*(kernel.shm_rmid_forced 除外)
  • kernel.msg*
  • kernel.sem
  • fs.mqueue.*
  • net.*(net.ipv4.tcp_syncookies、net.ipv4.ping_group_range、net.ipv4.ip_unprivileged_port_start 除外)
kernel.msgmax
NtpServerarray

NTP 服务器。

string

NTP 服务器。

ntp.cloud.aliyuncs.com
AcrRegistryInfoobject []

ACR 企业版实例信息列表。更多信息,请参见免密拉取 ACR 镜像

Domainarray

ACR 企业版实例的域名。默认为相应实例的所有域名。支持指定个别域名,多个以半角逗号分隔。

string

ACR 企业版实例的域名。默认为相应实例的所有域名。支持指定个别域名,多个以半角逗号分隔。

*****-****-registry.cn-beijing.cr.aliyuncs.com
InstanceNamestring

ACR 企业版实例的名称。

acr-test
InstanceIdstring

ACR 企业版实例 ID。

cri-nwj395hgf6f3****
RegionIdstring

ACR 企业版实例所属地域。

cn-beijing
ArnServicestring

ECI 实例等资源归属账号下的 RAM 角色的 ARN。

acs:ram::1609982529******:role/role-assume
ArnUserstring

ACR 实例归属账号下的 RAM 角色的 ARN。

acs:ram::1298452580******:role/role-acr
SpotDurationlong

抢占式实例的保护期。单位为小时。默认为 1。可设置为 0,表示无保护期。

1
StrictSpotboolean

是否周期执行:

  • true:周期执行。
  • false:非周期行执行。
true
PlainHttpRegistrystring

自建镜像仓库地址。使用 HTTP 协议的自建镜像仓库中的镜像创建 ECI 实例时,需配置该参数,使得 ECI 使用 HTTP 协议拉取镜像,避免因协议不同而导致镜像拉取失败。

"harbor***.pre.com,192.168.XX.XX:5000,reg***.test.com:80"
InsecureRegistrystring

自建镜像仓库地址。使用自签发证书的自建镜像仓库中的镜像创建 ECI 实例时,需配置该参数来跳过证书认证,避免因证书认证失败而导致镜像拉取失败。

"harbor***.pre.com,192.168.XX.XX:5000,reg***.test.com:80"
ImageAccelerateModestring

镜像加速模式。取值范围:

  • nydus:使用 Nydus 加速,需镜像本身支持。
  • dadi:使用 DADI 加速,需镜像本身支持。
  • p2p:使用 P2P 加速,需镜像本身支持。
  • imc:使用镜像缓存加速。
imc
Ipv6GatewayBandwidthEnableboolean

是否开通 ECI 的 IPv6 公网通信能力。

true
Ipv6GatewayBandwidthstring

当 Ipv6GatewayBandwidthEnable 配置为 true 时,配置 IPv6 地址的公网带宽峰值。取值如下:

  • 当 IPv6 网关的公网带宽计费方式为按固定带宽计费时,IPv6 地址的公网带宽范围为 1~2000 Mbps。
  • 当 IPv6 网关的公网带宽计费方式为按使用流量计费时,IPv6 地址的公网带宽范围受网关规格约束。
    • 网关为免费版,IPv6 地址的公网带宽范围为 1~200 Mbps。
    • 网关为企业版,IPv6 地址的公网带宽范围为 1~500 Mbps。
    • 网关为企业增强版,IPv6 地址的公网带宽范围为 1~1000 Mbps。

默认值为网关对应带宽范围的最大值。

100
ContainerResourceViewboolean

当 ECI 规格比申请规格大时,可以开启该配置,确保容器内看到的资源跟申请的资源保持一致。

false
FixedIpstring

配置为 true 表示实例启用固定 IP 地址。具体请参见配置 ECI 实例使用固定 IP 地址

true
FixedIpRetainHourinteger

固定 IP 地址空闲后的保留时长,即启用固定 IP 地址的实例释放后,其固定 IP 地址的保留时长,单位为小时。默认值为 48。

24
DataCacheBucketstring

数据缓存 Bucket。

default
DataCachePLstring

数据缓存使用的云盘的性能等级。
优先使用 ESSD 云盘,性能等级默认为 PL1。

PL1
DataCacheProvisionedIopslong

数据缓存使用 ESSD AutoPL 云盘时,ESSD AutoPL 云盘预配置的读写 IOPS。
取值范围:0~min{50000, 1000 * 容量-基准性能}。基准性能=min{1800+50 * 容量, 50000}。
更多信息,请参见ESSD AutoPL 云盘

40000
DataCacheBurstingEnabledboolean

数据缓存使用 ESSD AutoPL 云盘时,是否开启 Burst(性能突发)。更多信息,请参见ESSD AutoPL 云盘

false
DryRunboolean

是否只预检此次请求。取值范围:

  • true:发送检查请求,不会创建 ECI 实例。检查项包括是否填写了必填参数、请求格式、业务限制和库存。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码 DryRun.Success。
  • false(默认):发送正常请求,通过检查后直接创建 ECI 实例。
false
PrivateIpAddressstring

指定 ECI 实例的私网 IP 地址。目前仅支持指定 IPv4 地址,请确保该 IP 地址没有被占用。

172.16.0.1
OverheadReservationOptionobject

系统开销预留选项。

EnableOverheadReservationboolean

是否开启系统开销预留。默认为 false,如要开启,请设置为 true。开启后,系统会自动为 ECI 实例附加系统开销占用的内存,然后向上规整到最接近的规格,并按规整后的规格计费。

true
OsTypestring

指定 ECI 实例的操作系统。取值范围:

  • Linux(默认值)
  • Windows
说明 Windows 实例正在邀测中,如需使用,请提交工单申请。
Windows
CpuArchitecturestring

指定 ECI 实例的 CPU 架构。取值范围:

  • AMD64(默认值)
  • ARM64
ARM64
ComputeCategoryarray

指定算力类别。

string

指定算力类别。取值为 economy 时,表示使用经济型规格。

说明 目前仅支持指定经济型。
economy
GpuDriverVersionstring

指定 GPU 驱动版本。取值范围:

  • (默认)tesla=470.82.01
  • tesla=525.85.12
说明 仅部分规格支持切换 GPU 驱动版本。更多信息,请参见指定 GPU 规格创建实例
tesla=525.85.12

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID,唯一标识。

89945DD3-9072-47D0-A318-353284CFC7B3
ContainerGroupIdstring

实例 ID,即容器组 ID。

eci-uf6fonnghi50u374****

示例

正常返回示例

JSON格式

{
  "RequestId": "89945DD3-9072-47D0-A318-353284CFC7B3",
  "ContainerGroupId": "eci-uf6fonnghi50u374****"
}

错误码

HTTP status code错误码错误信息描述
400Account.ArrearageYour account has an outstanding payment.账号已经欠费。
400DryRunOperationRequest validation has been passed with DryRun flag set.此次DryRun预检请求合格。
400InvalidParameter.CPU.MemoryThe specified cpu and memory are not allowed-
400InvalidParameter.DuplicatedNameThe container group include containers with duplicate names.容器组内有重复名字的容器。
400InvalidParameter.DuplicatedVolumeNameThe container group includes volumes with duplicate names.容器组内有重复名字的数据卷。
400IncorrectStatus%s指定的实例状态不正确。
400ServiceNotEnabled%s该次请求所依赖的服务没有开通,请开通后再试。
400ImageSnapshot.IncorrectStatus%s用于镜像缓存的快照状态不正确。
400ImageSnapshot.NotSupport%s基于数据盘快照的镜像缓存功能暂未全网开放,如有需要请联系我们。
400DiskVolume.NotSupportThe disk volume is not supported.云盘卷暂不支持,如有需要请联系我们。
400RamRole.NotSupportThe RAM role is not supported.ram实例角色不支持。
400DiskNumber.LimitExceedThe maximum number of disks in an instance is exceeded.实例下云盘数目超过限制。
400InvalidPaymentMethod.InsufficientBalanceNo payment method is specified for your account. We recommend that you add a payment method or add funds to the prepayment balance.您的账户暂无有效支付方式,请添加支付方式或保持预付款余额充足。
400DiskVolume.NotInSameZoneThe instance to be created and the disk are not in the same zone.即将创建的实例和云盘不在同一可用区。
400NoPermissionYou are not authorized to use the "Product on ECI" feature.-
400HighCpuMemConfigRequiredYou need to apply to be added to the whitelist of the specified CPU and memory.您需要申请CPU高配白名单。
400RecommendEmpty.InstanceTypeFamilyNotMatchedThe recommended instance type is unavailable in the current zone. Try again later.当前可用区没有推荐的规格可使用,请稍后重试或者到其他的可用区创建。
400LocalDiskAmountNotMatchThe number of local volumes does not match the instance type.本地盘数量跟实例规格不匹配
400Payfor.CreditPayInsufficientBalanceYour payment credit line is insufficient.您的付款信用额度不足。
400InvalidOperation.KMS.InstanceTypeNotSupportThe specified instance is invalid. Only I/O optimized instances support KMS key.指定的实例无效,只有 I/O 优化类型的实例支持设置“KMS Key”。
400InvalidParameter.Encrypted.KmsNotEnabledKMS must be enabled for encrypted disks.加密磁盘需要启用密钥管理服务。
400InvalidParameter.KMS.EncryptedIllegalAfter configuring the parameter KmsKeyId, you must enable encryption.设置参数“KmsKeyId”后,您必须开启加密属性。
400InvalidSpotCpuMemorySpecThe specified CPU and memory are not allowed. You must create spot ECI using standard ECS specifications for CPU and memory.必须采用标准的ECS规格来创建ECI spot。
400Ipv6AddressNotSupportVswIPv6 is not supported in the specified vSwitch.该交换机暂未开通ipv6地址。
400Ipv6AddressNotSupportIpv6 is not supported in specified region.当前地域还不支持IPV6地址。
400Ipv6AddressNotSupportInstanceTypeIPv6 is not supported for the specified instance type.当前创建的规格不支持IPv6。
400EipPayInsufficientBalanceYour account does not have enough balance to purchase eip.当前账户余额不足以购买eip。
400EipPurchaseFlowControlRequest was denied due to eip frequent purchase.当前购买eip过于频繁,请稍后重试。
400ThrottlingYou have made too many requests within a short time; your request is denied due to request throttling-
400ThrottlingYou have made too many requests within a short time; your request is denied due to request throttling.短时间内请求过多。
400JobInstanceBatchCreateNotSupportECI job instance not support batch create-
400JobInstanceDiskNotSupportECI job instance not support disk volume-
400JobInstanceEipNotSupportECI job instance not support eip-
400JobInstanceFeatureNotMatchECI job instance feature not match-
400JobInstanceImageCacheNotSupportECI job instance not support image cache-
400JobInstanceIPv6NotSupportECI job instance not support IPv6-
400JobInstanceRamRoleNotSupportECI job instance not support ram role-
400JobInstanceRegionNotSupportECI job instance not support in this region-
400JobInstanceSpotNotSupportECI job instance not support spot-
400LocalDiskAmountNotMatchThe amount of local volume is not matched with instance type.指定的规格与定义的本地盘存储卷数据不匹配,请确保指定的规格有足够的本地盘数量。
400InvalidInstanceTypeForEciSpotDurationBuyCurrent instance type does not support spot duration instance.当前规格不支持eci自定义时长类型的spot实例。
400InvalidInstanceTypeForEciBuySales of this current instance type is not supported in eci.当前规格不在eci售卖规格范围内。
400InstanceTypeNotMatchCpuArch%s.您指定的ECS规格的CPU架构与您指定的CPU架构不匹配。
400JobInstanceEcsInstanceTypeNotSupportJob-optimized elastic container instances cannot be created by specifying ECS instance types.ECI Job优化型实例不支持指定ECS规格创建
400PrivatePoolInstanceSpotNotSupportSpot is not supported for PrivatePool.-
400DryRun.SuccessThis request is a dryrun request with successful result.该dryrun请求校验已经通过。
400PrivateIpAddress.Already.InUseThe specific PrivateIpAddress already in use.私网ip地址已经被占用
400IncorrectOperation%s当前的资源不支持该操作。
400FeatureBasedConstraintConflictA conflict occurs in specified feature constraints: [%s].指定的规格特性约束发生冲突
400OperationFailed.RiskControl%s.我们检测到您的账号存在安全风险,详情请联系客服人员。
403OperationDenied.VswZoneMisMatchThe specified VSwitchId is not in the specified Zone.-
403QuotaExceeded%s quota exceeded.用户允许创建的实例已经超过限制。
403Zone.NotOnSaleThe specified zone is not available for purchase.创建实例的可用区已经关闭售卖,请更换其他可用区。或者无法在该可用区使用指定 VPC 的虚拟交换机。
403Forbidden.RiskControlThis operation has been identified as an abnormal operation and cannot be processed.此操作已被确定为一个操作异常,无法处理。
403Forbidden.SubUserThe specified action is not available for you.当前用户无法执行该操作。
403Forbidden.OnlyForInvitedTestEci create action is only open to invited users during public beta.Eci公测阶段只对受邀的用户开放。
403OperationDenied.SecurityGroupMisMatchThe specified VSwitchId and SecurityGroupId are not in the same VPC.指定的交换机和安全组不在同一个VPC下。
403InvalidVSwitchId.IpNotEnoughThe specified VSwitch does not have enough IP addresses.-
403Forbidden.UserBussinessStatusThis operation is not allowed, because you have overdue bills. Pay the overdue bill and try again.用户处于欠费状态不允许创建,请充值后再尝试。
403Forbidden.UserNotRealNameAuthenticationThis operation is not allowed, because you have not passed the real-name verification.操作被禁止,因为用户还未进行实名认证。
403InvalidUser.PassRoleForbiddenThe RAM user is not authorized to assume a RAM role.子账号用户没有权限使用RAM实例角色。
403NoPermissionThe RAM role does not belong to ECS.-
403OperationDenied.NoStockSales of this resource are temporarily suspended in the specified zone. We recommend that you use the multi-zone creation function to avoid the risk of insufficient resource. For more information, see https://help.aliyun.com/document_detail/157290.html-
403InvalidParameter.KMS.KeyId.ForbiddenYou are not authorized to access the specified KMSKeyId.无权访问指定的 KMSKeyId。
403NoPermissionThe RAM role AliyunECIContainerGroupRole does not belong to eci.aliyuncs.com. Please check and try again.-
403Forbidden.AccountClosedThe operation is forbidden. Your account has been closed.操作被禁止,因为用户账户已注销。
403InvalidOperation.ResourceManagedByCloudProductThe operation is forbidden. The security group has been managed by another cloud product.安全组由其他云产品管理,禁止操作。
403Spot.NotMatched%s. We recommend that you use the create multi-zone function to avoid insufficient inventory. For more information, see https://help.aliyun.com/document_detail/157290.html-
403SecurityRisk.3DVerificationWe have detected a security risk with your default credit or debit card. Please proceed with verification via the link in your email.我们检测到您的默认信用卡或借记卡存在安全风险。请通过电子邮件中的链接进行验证。
403CreateServiceLinkedRole.DeniedPlease make sure the account has ram:CreateServiceLinkedRole permission.请确保账号拥有ram:CreateServiceLinkedRole权限。
403Throttling.Vcpu.PerDayThe maximum number of request for the day has been exceeded.当天的请求配额已经超出。
403OperationDenied.NoStockSales of this resource with specified features are temporarily suspended in the specified region; please check the instance type features and try again later.具有指定特征的资源在指定区域暂时停止销售;请检查与实例类型特征有关的参数,并稍后再试。
403FeatureAccessRestrictedAccess to this feature:[%s] is restricted. Please contact Alibaba Cloud ECI support to request access.使用该特性需要申请白名单,请联系阿里云ECI团队申请加白。
404ImageSnapshot.NotFoundThe specified snapshot does not exist.镜像缓存,快照不存在。
404InvalidDiskId.NotFoundThe specified disk does not exist.指定的云盘不存在。
404InvalidParameter.KMS.KeyId.NotFoundThe specified KMSKeyId does not exist.指定的参数“KMSKeyId”不存在。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-04-12OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
2024-04-12OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:GpuDriverVersion
2023-12-27OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
入参OpenAPI 入参发生变更