调用CreateContainerGroup创建一个ECI实例(即容器组)。
接口说明
调用 CreateContainerGroup 创建 ECI 实例时,系统将自动为您创建一个服务关联角色 AliyunServiceRoleForECI,用于访问 ECS、VPC 等相关云服务。更多信息,请参见弹性容器实例服务关联角色。
创建 ECI 实例时,您可以根据需要配置实例、镜像、存储等相关功能。各功能涉及的参数及其说明,请参见以下功能文档:
实例
ECI 支持以下两种方式创建实例:
以下功能两种创建方式均支持:
镜像
网络
存储
容器配置
日志与运维
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
eci:CreateContainerGroup | create | *ContainerGroup acs:eci:{#regionId}:{#accountId}:containergroup/* |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 地域 ID。 | cn-hangzhou |
ZoneId | string | 否 | 实例所属的可用区。如果取值为空,则表示由系统选择。 默认值为空。 | cn-hangzhou-b |
SecurityGroupId | string | 否 | 实例所属的安全组 ID。同一个安全组内的实例之间可以互相访问。 如果没有指定安全组,系统将自动使用您选择的地域下的默认安全组,您需要确保该安全组的入方向规则中包含容器需要暴露的协议和端口。如果您在该地域下没有默认安全组,系统将自动创建一个默认安全组,并将您声明的容器协议和端口添加到该安全组的入方向规则中。 | sg-uf66jeqopgqa9hdn**** |
VSwitchId | string | 否 | 实例所属的交换机 ID。支持指定多个交换机 ID(单次最多 10 个),各交换机 ID 之间可以用半角逗号(,)进行分割,例如 如果没有指定交换机,系统将自动使用您选择的地域下的默认 VPC 下的默认交换机,如果您在该地域下没有默认 VPC 和默认交换机,系统将自动创建一个默认 VPC 和一个默认交换机。 说明
交换机网段内的 IP 个数决定了该交换机下最大可以创建的 ECI 实例数量,请务必提前规划好网段。
| vsw-bp1xpiowfm5vo8o3c****,vsw-bp1rkyjgr1xwoho6k**** |
ContainerGroupName | string | 是 | ECI 实例名称,即容器组名称。格式要求如下:
| nginx-test |
RestartPolicy | string | 否 | 实例重启策略。取值范围:
默认值:Always。 | Always |
EipInstanceId | string | 否 | 弹性公网 IP ID。 | eip-uf66jeqopgqa9hdn**** |
Cpu | float | 否 | 实例级别 vCPU 大小。单位:核。 | 1.0 |
Memory | float | 否 | 实例级别内存大小。单位:GiB。 | 2.0 |
ResourceGroupId | string | 否 | 资源组 ID。 | rg-uf66jeqopgqa9hdn**** |
DnsPolicy | string | 否 | DNS 策略。取值范围:
| Default |
ClientToken | string | 否 | 保证请求幂等性。从您的客户端生成一个参数值,确保不同请求间该参数值唯一。只支持 ASCII 字符,且不能超过 64 个字符。更多详情,请参阅如何保证幂等性。 | 123e4567-xxxx-12d3-xxxx-426655440000 |
InstanceType | string | 否 | 指定的 ECS 实例规格,支持多规格。更多信息,请参见指定 ECS 规格创建实例。 | ecs.c5.xlarge |
ImageSnapshotId | string | 否 | 镜像缓存 ID。更多信息,请参见使用镜像缓存加速创建实例。 | imc-2zebxkiifuyzzlhl**** |
RamRoleName | string | 否 | 实例 RAM 角色名称。ECI 与 ECS 共用实例 RAM 角色,更多信息,请参见通过 API 使用实例 RAM 角色。 | RamTestRole |
TerminationGracePeriodSeconds | long | 否 | 程序的缓冲时间,用于处理关闭之前的操作。单位为秒。 | 60 |
AutoMatchImageCache | boolean | 否 | 是否自动匹配镜像缓存。默认为 false。 | false |
Ipv6AddressCount | integer | 否 | IPv6 地址数。固定为 1,即一个 ECI 实例支持绑定一个 IPv6 地址。 | 1 |
ActiveDeadlineSeconds | long | 否 | ECI 实例的有效期限,超出该时间后,实例会被强制退出。单位为秒。 | 1000 |
SpotStrategy | string | 否 | 实例的抢占策略。取值范围:
默认值:NoSpot。 | SpotWithPriceLimit |
SpotPriceLimit | float | 否 | 设置抢占式实例的每小时最高价格,最多精确到小数点后 3 位。 当 SpotStrategy 取值为 SpotWithPriceLimit 时,必须设置 SpotPriceLimit。 | 0.025 |
ScheduleStrategy | string | 否 | 配置了多可用区(通过 VSwitchId 参数指定多个交换机)时,ECI 实例的调度策略。取值范围:
更多信息,请参见多可用区创建实例。 | VSwitchOrdered |
CorePattern | string | 否 | 自定义设置 coredump 生成的 core 文件的保存目录。更多信息,请参见设置 core 文件保存到数据卷。 说明
配置的路径不能以 | 开头,即不能通过 Core dump 来配置可执行程序。
| /xx/xx/core |
ShareProcessNamespace | boolean | 否 | 是否使用共享命名空间。默认为 false。 | false |
AutoCreateEip | boolean | 否 | 是否自动创建一个 EIP,并绑定到 ECI 实例上。 | true |
EipBandwidth | integer | 否 | EIP 的带宽,默认为 5 Mbps。 | 5 |
EipISP | string | 否 | 设置 EIP 的线路类型。取值范围:
| BGP |
EipCommonBandwidthPackage | string | 否 | 绑定已有的共享带宽包。 | cbwp-2zeukbj916scmj51m**** |
HostName | string | 否 | 主机名称。 | test |
IngressBandwidth | long | 否 | 入方向带宽限制。单位:Bps。 | 1024000 |
EgressBandwidth | long | 否 | 出方向带宽限制。单位:Bps。 | 1024000 |
CpuOptionsCore | integer | 否 | CPU 物理核心数。仅部分规格支持自定义设置。 | 2 |
CpuOptionsThreadsPerCore | integer | 否 | 每核线程数。仅部分规格支持自定义设置。配置为 1 时表示关闭超线程。 | 2 |
CpuOptionsNuma | string | 否 | 该参数暂不支持设置。 | 1 |
EphemeralStorage | integer | 否 | 增加的临时存储空间大小。单位:GiB。 | 20 |
Tag | array<object> | 否 | 标签列表。最多可以绑定 20 个。更多信息,请参见使用标签管理实例。 | |
object | 否 | 标签列表。最多可以绑定 20 个。更多信息,请参见使用标签管理实例。 | ||
Key | string | 否 | 标签键。如果传入该值,则不允许为空字符串,且不允许重复。最多支持 64 个字符,不能以 | version |
Value | string | 否 | 标签值。如果传入该值,可以为空字符串。最多支持 128 个字符,不能以 | 3 |
ImageRegistryCredential | array<object> | 否 | 镜像仓库信息。 | |
object | 否 | 镜像仓库信息。 | ||
Password | string | 否 | 镜像仓库密码。 | yourpassword |
Server | string | 否 | 镜像仓库注册地址。 | registry-vpc.cn-shanghai.aliyuncs.com |
UserName | string | 否 | 镜像仓库用户名。 | yourusername |
Container | array<object> | 是 | 容器信息。 | |
object | 是 | 容器信息。 | ||
ReadinessProbe.TimeoutSeconds | integer | 否 | 检查超时的时间,默认为 1 秒,最小为 1 秒。 | 1 |
ReadinessProbe.SuccessThreshold | integer | 否 | 从上次检查失败后重新认定检查成功的检查次数阈值(必须是连续成功),默认为 1。当前必须为 1。 | 1 |
SecurityContext.Capability.Add | array | 否 | 为容器内的进程授予某些特定的权限。目前仅支持配置为 NET_ADMIN 和 NET_RAW。 说明
NET_RAW 默认不支持,需提交工单申请。
| |
string | 否 | 为容器内的进程授予某些特定的权限。目前仅支持配置为 NET_ADMIN 和 NET_RAW。 说明
NET_RAW 默认不支持,需提交工单申请。
| NET_ADMIN | |
ReadinessProbe.TcpSocket.Port | integer | 否 | 使用 TCP Socket 方式进行健康检查时,TCP Socket 检测的端口。 说明
设置 ReadinessProbe 相关参数时,HttpGet、Exec 和 TcpSocket 这三种检查方式,只能选择其中一种。
| 8000 |
ReadinessProbe.HttpGet.Scheme | string | 否 | 使用 HTTP 请求方式进行健康检查时,HTTP Get 请求对应的协议类型,取值范围:
说明
设置 ReadinessProbe 相关参数时,HttpGet、Exec 和 TcpSocket 这三种检查方式,只能选择其中一种。
| HTTP |
LivenessProbe.PeriodSeconds | integer | 否 | 检查执行的周期,默认为 10 秒,最小为 1 秒。 | 5 |
SecurityContext.ReadOnlyRootFilesystem | boolean | 否 | 容器运行的根文件系统是否为只读,目前仅支持配置为 true。 | true |
EnvironmentVar | array<object> | 否 | 容器的环境变量值。 | |
object | 否 | 容器的环境变量值。 | ||
Key | string | 否 | 环境变量名。长度为 1~128 位。格式要求: | PATH |
Value | string | 否 | 环境变量值。长度为 0~256 位。 | /usr/local/bin |
FieldRef.FieldPath | string | 否 | 环境变量值引用。目前只支持配置为 status.podIP。 | status.podIP |
LivenessProbe.TcpSocket.Port | integer | 否 | 使用 TCP Socket 方式进行健康检查时,TCP Socket 检测的端口。 说明
设置 LivenessProbe 相关参数时,HttpGet、Exec 和 TcpSocket 这三种检查方式,只能选择其中一种。
| 8080 |
Tty | boolean | 否 | 是否开启交互。默认为 false。 当 Command 为/bin/bash 命令时,需要设置为 true。 | false |
WorkingDir | string | 否 | 容器工作目录。 | /usr/local/ |
Arg | array | 否 | 容器启动命令对应的参数。最多 10 个。 | |
string | 否 | 容器启动命令对应的参数。最多 10 个。 | 100 | |
Stdin | boolean | 否 | 此容器是否应在容器运行时为标准输入分配缓冲区。如果未设置,则容器中标准输入的读取值将导致 EOF。默认为 false。 | false |
LivenessProbe.InitialDelaySeconds | integer | 否 | 检查开始执行的时间,以容器启动完成为起点计算。 | 5 |
VolumeMount | array<object> | 否 | 数据卷信息。 | |
object | 否 | 数据卷信息。 | ||
MountPropagation | string | 否 | 数据卷的挂载传播设置。挂载传播允许将 Container 挂载的卷共享到同一 Pod 中的其他 Container,甚至可以共享到同一节点上的其他 Pod。取值范围:
默认值:None | None |
MountPath | string | 否 | 容器挂载数据卷的目录。 说明
容器挂载目录下的内容会被 Volume 的内容直接覆盖,请谨慎使用。
| /pod/data |
ReadOnly | boolean | 否 | 数据卷是否只读。默认为 false。 | false |
SubPath | string | 否 | 数据卷子路径。 | data2/ |
Name | string | 否 | 数据卷名称。同 Volume 中的 Name。 | default-volume1 |
ImagePullPolicy | string | 否 | 镜像拉取策略。取值范围:
| Always |
StdinOnce | boolean | 否 | 当标准输入为 true 时,标准输入流将在多个附加会话中是否保持开启状态。 | false |
LifecyclePreStopHandlerTcpSocketPort | integer | 否 | 使用 TCPSocket 方式设置 preStop 回调函数时,TCP Socket 检测的端口。 | 90 |
LifecyclePostStartHandlerHttpGetScheme | string | 否 | 使用 HTTP 请求方式设置 postStart 回调函数时,HTTP Get 请求对应的协议类型,取值范围:
| HTTPS |
ReadinessProbe.PeriodSeconds | integer | 否 | 检查执行的周期,默认为 10 秒,最小为 1 秒。 | 3 |
LivenessProbe.SuccessThreshold | integer | 否 | 从上次检查失败后重新认定检查成功的检查次数阈值(必须是连续成功),默认为 1。当前必须为 1。 | 1 |
Command | array | 否 | 容器启动命令。最多 20 个。每个命令最多包含 256 个字符。 | |
string | 否 | 容器启动命令。最多 20 个。每个命令最多包含 256 个字符。 | sleep | |
LifecyclePostStartHandlerHttpGetHost | string | 否 | 使用 HTTP 请求方式设置 postStart 回调函数时,接收 HTTP Get 请求的主机地址。 | 10.0.XX.XX |
TerminationMessagePolicy | string | 否 | 消息通知策略,默认为空,目前仅支持轻量消息队列的消息通知。 | FallbackToLogsOnError |
ReadinessProbe.HttpGet.Path | string | 否 | 使用 HTTP 请求方式进行健康检查时,HTTP Get 请求检测的路径。 说明
设置 ReadinessProbe 相关参数时,HttpGet、Exec 和 TcpSocket 这三种检查方式,只能选择其中一种。
| /healthz |
LivenessProbe.Exec.Command | array | 否 | 使用命令行方式进行健康检查时,在容器内执行的命令。 说明
设置 LivenessProbe 相关参数时,HttpGet、Exec 和 TcpSocket 这三种检查方式,只能选择其中一种。
| |
string | 否 | 使用命令行方式进行健康检查时,在容器内执行的命令。 | cat /tmp/healthy | |
LifecyclePostStartHandlerTcpSocketPort | integer | 否 | 使用 TCPSocket 方式设置 postStart 回调函数时,TCP Socket 检测的端口。 | 80 |
LifecyclePostStartHandlerHttpGetPath | string | 否 | 使用 HTTP 请求方式设置 postStart 回调函数时,HTTP Get 请求检测的路径。 | /healthyz |
LifecyclePostStartHandlerExec | array | 否 | 使用命令行方式设置 postStart 回调函数时,在容器内执行的命令。 | |
string | 否 | 使用命令行方式设置 postStart 回调函数时,在容器内执行的命令。 | ["/bin/sh", "-c", "echo Hello from the postStart handler > /usr/share/message"] | |
LifecyclePreStopHandlerHttpGetPath | string | 否 | 使用 HTTP 请求方式设置 preStop 回调函数时,HTTP Get 请求检测的路径。 | /healthyz |
Port | array<object> | 否 | 端口号。 | |
object | 否 | 端口号。 | ||
Protocol | string | 否 | 协议类型。取值范围:
| TCP |
Port | integer | 否 | 端口号。取值范围:1~65535。 | 80 |
TerminationMessagePath | string | 否 | 容器的报错地址。 | /tmp/termination-log |
LifecyclePreStopHandlerHttpGetScheme | string | 否 | 使用 HTTP 请求方式设置 preStop 回调函数时,HTTP Get 请求对应的协议类型,取值范围:
| HTTP |
LivenessProbe.HttpGet.Scheme | string | 否 | 使用 HTTP 请求方式进行健康检查时,HTTP Get 请求对应的协议类型,取值范围:
说明
设置 LivenessProbe 相关参数时,HttpGet、Exec 和 TcpSocket 这三种检查方式,只能选择其中一种。
| HTTP |
ReadinessProbe.HttpGet.Port | integer | 否 | 使用 HTTP 请求方式进行健康检查时,HTTP Get 请求检测的端口号。 说明
设置 ReadinessProbe 相关参数时,HttpGet、Exec 和 TcpSocket 这三种检查方式,只能选择其中一种。
| 8080 |
LifecyclePostStartHandlerTcpSocketHost | string | 否 | 使用 TCP Socket 方式设置 postStart 回调函数时,TCP Socket 检测的主机地址。 | 10.0.XX.XX |
Gpu | integer | 否 | 指定容器使用的 GPU 个数。 | 1 |
ReadinessProbe.InitialDelaySeconds | integer | 否 | 检查开始执行的时间,以容器启动完成为起点计算。 | 3 |
LifecyclePreStopHandlerExec | array | 否 | 使用命令行方式设置 preStop 回调函数时,在容器内执行的命令。 | |
string | 否 | 使用命令行方式设置 preStop 回调函数时,在容器内执行的命令。 | ["/bin/sh", "-c","echo Hello from the preStop handler > /usr/share/message"] | |
Memory | float | 否 | 容器的内存大小。单位:GiB。 | 0.5 |
Name | string | 是 | 容器名称。 | nginx |
LifecyclePreStopHandlerHttpGetHost | string | 否 | 使用 HTTP 请求方式设置 preStop 回调函数时,接收 HTTP Get 请求的主机地址。 | 10.0.XX.XX |
LifecyclePreStopHandlerTcpSocketHost | string | 否 | 使用 TCP Socket 方式设置 preStop 回调函数时,TCP Socket 检测的主机地址。 | 10.0.XX.XX |
Image | string | 是 | 容器镜像。 | registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:latest |
LifecyclePreStopHandlerHttpGetPort | integer | 否 | 使用 HTTP 请求方式设置 preStop 回调函数时,HTTP Get 请求检测的端口号。 | 88 |
LivenessProbe.FailureThreshold | integer | 否 | 从上次检查成功后认定检查失败的检查次数阈值(必须是连续失败),默认为 3。 | 3 |
ReadinessProbe.Exec.Command | array | 否 | 使用命令行方式进行健康检查时,在容器内执行的命令。 说明
设置 ReadinessProbe 相关参数时,HttpGet、Exec 和 TcpSocket 这三种检查方式,只能选择其中一种。
| |
string | 否 | 使用命令行方式进行健康检查时,在容器内执行的命令。 | cat /tmp/healthy | |
LifecyclePreStopHandlerHttpGetHttpHeader | array<object> | 否 | 生成的 HTTP 请求头参数。 | |
object | 否 | 生成的 HTTP 请求头参数。 | ||
Value | string | 否 | 使用 HTTP 请求方式设置 preStop 回调函数时,HTTP Get 请求头中自定义设置的字段值。 | test-preStop |
Name | string | 否 | 使用 HTTP 请求方式设置 preStop 回调函数时,HTTP Get 请求头中自定义设置的字段名。 | Xiao-Custom-Header |
ReadinessProbe.FailureThreshold | integer | 否 | 从上次检查成功后认定检查失败的检查次数阈值(必须是连续失败),默认为 3。 | 3 |
Cpu | float | 否 | 容器的 vCPU 大小。单位:核。 | 0.25 |
LivenessProbe.HttpGet.Port | integer | 否 | 使用 HTTP 请求方式进行健康检查时,HTTP Get 请求检测的端口号。 说明
设置 LivenessProbe 相关参数时,HttpGet、Exec 和 TcpSocket 这三种检查方式,只能选择其中一种。
| 8888 |
LivenessProbe.HttpGet.Path | string | 否 | 使用 HTTP 请求方式进行健康检查时,HTTP Get 请求检测的路径。 说明
设置 LivenessProbe 相关参数时,HttpGet、Exec 和 TcpSocket 这三种检查方式,只能选择其中一种。
| /healthz |
LivenessProbe.TimeoutSeconds | integer | 否 | 检查超时的时间,默认为 1 秒,最小为 1 秒。 | 1 |
SecurityContext.RunAsUser | long | 否 | 设置运行容器的用户 ID。 | 1000 |
LifecyclePostStartHandlerHttpGetPort | integer | 否 | 使用 HTTP 请求方式设置 postStart 回调函数时,HTTP Get 请求检查的端口号。 | 5050 |
LifecyclePostStartHandlerHttpGetHttpHeader | array<object> | 否 | 生成的 HTTP 请求头参数。 | |
object | 否 | 生成的 HTTP 请求头参数。 | ||
Value | string | 否 | 使用 HTTP 请求方式设置 postStart 回调函数时,HTTP Get 请求头中自定义设置的字段值。 | test-postStart |
Name | string | 否 | 使用 HTTP 请求方式设置 postStart 回调函数时,HTTP Get 请求头中自定义设置的字段名。 | Xiao-Custom-Header |
EnvironmentVarHide | boolean | 否 | 查询 ECI 实例详情时,是否隐藏环境变量信息。取值范围:
| false |
SecurityContextRunAsGroup | long | 否 | 设置运行容器的用户组。 | 3000 |
SecurityContextRunAsNonRoot | boolean | 否 | 是否以非 root 模式运行容器。取值范围:
| true |
SecurityContextPrivileged | boolean | 否 | 容器是否启用特权,即是否以特权模式运行容器。取值范围:
说明
特权容器功能正在内测中。如需体验,请提交工单申请。
| true |
Volume | array<object> | 否 | 数据卷信息。 | |
object | 否 | 数据卷信息。 | ||
Type | string | 否 | 数据卷类型。取值范围:
| ConfigFileVolume |
DiskVolume.DiskSize | integer | 否 | DiskVolume 的大小。单位为 GiB。 | 15 |
NFSVolume.Path | string | 否 | NFS 数据卷路径。 | /share |
DiskVolume.FsType | string | 否 | DiskVolume 的系统类型。 | xfs |
FlexVolume.FsType | string | 否 | 挂载的文件系统类型,默认取决于 FlexVolume 的 script。 | ext4 |
HostPathVolume.Type | string | 否 | HostPath Volume 的类型。取值范围:
说明
HostPath Volume 仅对白名单用户开放使用。
| Directory |
ConfigFileVolume.DefaultMode | integer | 否 | ConfigFileVolume 默认的权限。 | 0644 |
NFSVolume.ReadOnly | boolean | 否 | NFS 数据卷是否只读。默认为 false。 | false |
ConfigFileVolume.ConfigFileToPath | array<object> | 否 | ConfigFile 类型的数据卷信息。 如果配置多个 ConfigFileToPath,对应的多个 Content 的总长度不能超过 60 KB。 | |
object | 否 | ConfigFile 类型的数据卷信息。 | ||
Path | string | 否 | 相对于挂载目录,配置文件所在的相对文件路径。 | test/config-test.cnf |
Mode | integer | 否 | 配置文件的权限,如果没有设置,则采用 ConfigFileVolume.DefaultMode 的值。采用四位八进制数表示,例如 0644 表示权限为 rw-r–r--,即用户权限为 rw-,用户所在组权限为 r--,其他用户权限为 r--。 权限说明如下:
| 0644 |
Content | string | 否 | 配置文件内容,需要将内容进行 Base64 编码。 | bGl1bWk= |
HostPathVolume.Path | string | 否 | HostPath Volume 在主机上的目录路径。 | /pod/data |
FlexVolume.Options | string | 否 | {"volumeId":"d-2zehdahrwoa7srg****","performanceLevel": "PL2"} | |
FlexVolume.Driver | string | 否 | 使用 FlexVolume 插件挂载数据卷时的驱动类型。取值范围如下:
| alicloud/disk |
NFSVolume.Server | string | 否 | NFS 服务器地址。 | 3f9cd4a596-naw76.cn-shanghai.nas.aliyuncs.com |
DiskVolume.DiskId | string | 否 | DiskVolume 的 ID。 | d-xx |
Name | string | 否 | 数据卷名称。 | default-volume1 |
EmptyDirVolume.Medium | string | 否 | EmptyDirVolume 的存储媒介,默认为空,使用 node 文件系统;支持 memory,表示使用内存。 | memory |
EmptyDirVolume.SizeLimit | string | 否 | EmptyDirVolume 的大小。单位为 GiB。 | 2 |
InitContainer | array<object> | 否 | Init 容器列表。 | |
object | 否 | Init 容器列表。 | ||
SecurityContext.Capability.Add | array | 否 | 为容器内的进程授予某些特定的权限。目前仅支持配置为 NET_ADMIN 和 NET_RAW。 说明
NET_RAW 默认不支持,需提交工单申请。
| |
string | 否 | 为容器内的进程授予某些特定的权限。目前仅支持配置为 NET_ADMIN 和 NET_RAW。 说明
NET_RAW 默认不支持,需提交工单申请。
| NET_ADMIN | |
Image | string | 否 | 容器使用的镜像。 | nginx |
VolumeMount | array<object> | 否 | 挂载数据卷信息列表。 | |
object | 否 | 挂载数据卷信息列表。 | ||
MountPropagation | string | 否 | 数据卷的挂载传播设置。挂载传播允许将 Container 挂载的卷共享到同一 Pod 中的其他 Container,甚至可以共享到同一节点上的其他 Pod。取值范围:
默认值:None | None |
MountPath | string | 否 | 挂载目录,容器的挂载目录下的内容被 volume 的内容直接覆盖,所以要慎用。 | /usr/share/ |
ReadOnly | boolean | 否 | 挂载路径是否只读。默认为 false。 | false |
SubPath | string | 否 | 数据卷下的子目录,方便 Pod 将同一个 Volume 下不同目录挂载到容器不同目录。 | /usr/sub/ |
Name | string | 否 | 挂载数据卷的名称。 | test-empty |
Port | array<object> | 否 | init 容器端口号。 | |
object | 否 | init 容器端口号。 | ||
Protocol | string | 否 | 协议类型。取值范围:
| TCP |
Port | integer | 否 | 端口号。取值范围:1~65535。 | 8888 |
SecurityContext.ReadOnlyRootFilesystem | boolean | 否 | 容器运行的根文件系统是否为只读。目前仅支持配置为 true。 | true |
TerminationMessagePath | string | 否 | 容器退出的消息来源。当容器退出时,从指定的终止消息文件中检索终止消息。 | /tmp/termination-log |
EnvironmentVar | array<object> | 否 | 容器的环境变量信息列表。 | |
object | 否 | 容器的环境变量信息列表。 | ||
Key | string | 否 | 环境变量名。长度为 1~128 位。格式要求: | Path |
Value | string | 否 | 环境变量值。长度为 0~256 位。 | /usr/bin/ |
FieldRef.FieldPath | string | 否 | 环境变量值引用。目前只支持配置为 status.podIP。 | status.podIP |
ImagePullPolicy | string | 否 | 镜像拉取策略。取值范围:
| Always |
WorkingDir | string | 否 | 工作目录。 | /usr/local |
Cpu | float | 否 | 容器的 vCPU 大小。单位:核。 | 0.5 |
Arg | array | 否 | 容器启动参数。 | |
string | 否 | 容器启动参数。 | 10 | |
Command | array | 否 | 容器启动指令。 | |
string | 否 | 容器启动指令。 | sleep | |
Gpu | integer | 否 | 指定容器使用的 GPU 个数。 | 1 |
SecurityContext.RunAsUser | long | 否 | 设置运行容器的用户 ID。 | 587 |
Memory | float | 否 | 容器的内存大小。单位:GiB。 | 1.0 |
TerminationMessagePolicy | string | 否 | 挂载信息,默认为空。 | ***** |
Name | string | 否 | 容器名称。 | test-init |
DnsConfig.NameServer | array | 否 | DNS 服务器的 IP 地址列表。 | |
string | 否 | DNS 服务器的 IP 地址列表。 | 172.10.*.** | |
DnsConfig.Search | array | 否 | DNS 搜索域列表。 | |
string | 否 | DNS 搜索域列表。 | svc.local.kubernetes | |
DnsConfig.Option | array<object> | 否 | 对象的选项列表。 | |
object | 否 | 对象的选项列表。 | ||
Value | string | 否 | 对象的 Value。 | value |
Name | string | 否 | 对象的 Name。 | name |
HostAliase | array<object> | 否 | 添加一个 ECI 的别名。 | |
object | 否 | 添加一个 ECI 的别名。 | ||
Ip | string | 否 | 添加 IP。 | 1.1.1.1 |
Hostname | array | 否 | 添加主机名。 | |
string | 否 | 添加主机名。 | hehe.com | |
SecurityContext.Sysctl | array<object> | 否 | 通过安全上下文修改安全 sysctl 参数。更多信息,请参见配置 Security Context。 | |
object | 否 | 通过安全上下文修改安全 sysctl 参数。更多信息,请参见配置 Security Context。 | ||
Value | string | 否 | 通过安全上下文修改 sysctl 参数时,安全 sysctl 参数的取值。 | 65536 |
Name | string | 否 | 通过安全上下文修改 sysctl 参数时,安全 sysctl 参数的名称。取值范围:
| net.ipv4.ping_group_range |
HostSecurityContext.Sysctl | array<object> | 否 | 通过安全上下文修改非安全 sysctl 参数。更多信息,请参见配置 Security Context。 | |
object | 否 | 通过安全上下文修改非安全 sysctl 参数。更多信息,请参见配置 Security Context。 | ||
Value | string | 否 | 通过安全上下文修改 sysctl 参数时,非安全 sysctl 参数的取值。 | 65536 |
Name | string | 否 | 通过安全上下文修改 sysctl 参数时,非安全 sysctl 参数的名称。取值范围:
| kernel.msgmax |
NtpServer | array | 否 | NTP 服务器。 | |
string | 否 | NTP 服务器。 | ntp.cloud.aliyuncs.com | |
AcrRegistryInfo | array<object> | 否 | ACR 企业版实例信息列表。更多信息,请参见免密拉取 ACR 镜像。 | |
object | 否 | ACR 企业版实例信息列表。 | ||
Domain | array | 否 | ACR 企业版实例的域名。默认为相应实例的所有域名。支持指定个别域名,多个以半角逗号分隔。 | |
string | 否 | ACR 企业版实例的域名。默认为相应实例的所有域名。支持指定个别域名,多个以半角逗号分隔。 | *****-****-registry.cn-beijing.cr.aliyuncs.com | |
InstanceName | string | 否 | ACR 企业版实例的名称。 | acr-test |
InstanceId | string | 否 | ACR 企业版实例 ID。 | cri-nwj395hgf6f3**** |
RegionId | string | 否 | ACR 企业版实例所属地域。 | cn-beijing |
ArnService | string | 否 | ECI 实例等资源归属账号下的 RAM 角色的 ARN。 | acs:ram::1609982529******:role/role-assume |
ArnUser | string | 否 | ACR 实例归属账号下的 RAM 角色的 ARN。 | acs:ram::1298452580******:role/role-acr |
SpotDuration | long | 否 | 抢占式实例的保护期。单位为小时。默认为 1。可设置为 0,表示无保护期。 | 1 |
StrictSpot | boolean | 否 | 是否周期执行:
| true |
PlainHttpRegistry | string | 否 | 自建镜像仓库地址。使用 HTTP 协议的自建镜像仓库中的镜像创建 ECI 实例时,需配置该参数,使得 ECI 使用 HTTP 协议拉取镜像,避免因协议不同而导致镜像拉取失败。 | "harbor***.pre.com,192.168.XX.XX:5000,reg***.test.com:80" |
InsecureRegistry | string | 否 | 自建镜像仓库地址。使用自签发证书的自建镜像仓库中的镜像创建 ECI 实例时,需配置该参数来跳过证书认证,避免因证书认证失败而导致镜像拉取失败。 | "harbor***.pre.com,192.168.XX.XX:5000,reg***.test.com:80" |
ImageAccelerateMode | string | 否 | 镜像加速模式。取值范围:
| imc |
Ipv6GatewayBandwidthEnable | boolean | 否 | 是否开通 ECI 的 IPv6 公网通信能力。 | true |
Ipv6GatewayBandwidth | string | 否 | 当 Ipv6GatewayBandwidthEnable 配置为 true 时,配置 IPv6 地址的公网带宽峰值。取值如下:
默认值为网关对应带宽范围的最大值。 | 100 |
ContainerResourceView | boolean | 否 | 当 ECI 规格比申请规格大时,可以开启该配置,确保容器内看到的资源跟申请的资源保持一致。 | false |
FixedIp | string | 否 | 配置为 true 表示实例启用固定 IP 地址。具体请参见配置 ECI 实例使用固定 IP 地址。 | true |
FixedIpRetainHour | integer | 否 | 固定 IP 地址空闲后的保留时长,即启用固定 IP 地址的实例释放后,其固定 IP 地址的保留时长,单位为小时。默认值为 48。 | 24 |
DataCacheBucket | string | 否 | 数据缓存 Bucket。 | default |
DataCachePL | string | 否 | 数据缓存使用的云盘的性能等级。 | PL1 |
DataCacheProvisionedIops | long | 否 | 数据缓存使用 ESSD AutoPL 云盘时,ESSD AutoPL 云盘预配置的读写 IOPS。 | 40000 |
DataCacheBurstingEnabled | boolean | 否 | 数据缓存使用 ESSD AutoPL 云盘时,是否开启 Burst(性能突发)。更多信息,请参见ESSD AutoPL 云盘。 | false |
DryRun | boolean | 否 | 是否只预检此次请求。取值范围:
| false |
PrivateIpAddress | string | 否 | 指定 ECI 实例的私网 IP 地址。目前仅支持指定 IPv4 地址,请确保该 IP 地址没有被占用。 | 172.16.0.1 |
OverheadReservationOption | object | 否 | 系统开销预留选项。 | |
EnableOverheadReservation | boolean | 否 | 是否开启系统开销预留。默认为 false,如要开启,请设置为 true。开启后,系统会自动为 ECI 实例附加系统开销占用的内存,然后向上规整到最接近的规格,并按规整后的规格计费。 | true |
OsType | string | 否 | 指定 ECI 实例的操作系统。取值范围:
说明
Windows 实例正在邀测中,如需使用,请提交工单申请。
| Windows |
CpuArchitecture | string | 否 | 指定 ECI 实例的 CPU 架构。取值范围:
| ARM64 |
ComputeCategory | array | 否 | 指定算力类别。更多信息,请参见指定算力类别创建实例。 | |
string | 否 | 指定算力类别。取值范围:
支持设置多个算力类别,系统会按照设置顺序创建。 | economy | |
GpuDriverVersion | string | 否 | tesla=525.85.12 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "89945DD3-9072-47D0-A318-353284CFC7B3",
"ContainerGroupId": "eci-uf6fonnghi50u374****"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | Account.Arrearage | Your account has an outstanding payment. | 账号已经欠费。 |
400 | DryRunOperation | Request validation has been passed with DryRun flag set. | 此次DryRun预检请求合格。 |
400 | InvalidParameter.CPU.Memory | The specified cpu and memory are not allowed | - |
400 | InvalidParameter.DuplicatedName | The container group include containers with duplicate names. | 容器组内有重复名字的容器。 |
400 | InvalidParameter.DuplicatedVolumeName | The container group includes volumes with duplicate names. | 容器组内有重复名字的数据卷。 |
400 | IncorrectStatus | %s | 指定的实例状态不正确。 |
400 | ServiceNotEnabled | %s | 该次请求所依赖的服务没有开通,请开通后再试。 |
400 | ImageSnapshot.IncorrectStatus | %s | 用于镜像缓存的快照状态不正确。 |
400 | ImageSnapshot.NotSupport | %s | 基于数据盘快照的镜像缓存功能暂未全网开放,如有需要请联系我们。 |
400 | DiskVolume.NotSupport | The disk volume is not supported. | 云盘卷暂不支持,如有需要请联系我们。 |
400 | RamRole.NotSupport | The RAM role is not supported. | ram实例角色不支持。 |
400 | DiskNumber.LimitExceed | The maximum number of disks in an instance is exceeded. | 实例下云盘数目超过限制。 |
400 | InvalidPaymentMethod.InsufficientBalance | No payment method is specified for your account. We recommend that you add a payment method or add funds to the prepayment balance. | 您的账户暂无有效支付方式,请添加支付方式或保持预付款余额充足。 |
400 | DiskVolume.NotInSameZone | The instance to be created and the disk are not in the same zone. | 即将创建的实例和云盘不在同一可用区。 |
400 | NoPermission | You are not authorized to use the "Product on ECI" feature. | - |
400 | HighCpuMemConfigRequired | You need to apply to be added to the whitelist of the specified CPU and memory. | 您需要申请CPU高配白名单。 |
400 | RecommendEmpty.InstanceTypeFamilyNotMatched | The recommended instance type is unavailable in the current zone. Try again later. | 当前可用区没有推荐的规格可使用,请稍后重试或者到其他的可用区创建。 |
400 | LocalDiskAmountNotMatch | The number of local volumes does not match the instance type. | 本地盘数量跟实例规格不匹配 |
400 | Payfor.CreditPayInsufficientBalance | Your payment credit line is insufficient. | 您的付款信用额度不足。 |
400 | InvalidOperation.KMS.InstanceTypeNotSupport | The specified instance is invalid. Only I/O optimized instances support KMS key. | 指定的实例无效,只有 I/O 优化类型的实例支持设置“KMS Key”。 |
400 | InvalidParameter.Encrypted.KmsNotEnabled | KMS must be enabled for encrypted disks. | 加密磁盘需要启用密钥管理服务。 |
400 | InvalidParameter.KMS.EncryptedIllegal | After configuring the parameter KmsKeyId, you must enable encryption. | 设置参数“KmsKeyId”后,您必须开启加密属性。 |
400 | InvalidSpotCpuMemorySpec | The specified CPU and memory are not allowed. You must create spot ECI using standard ECS specifications for CPU and memory. | 必须采用标准的ECS规格来创建ECI spot。 |
400 | Ipv6AddressNotSupportVsw | IPv6 is not supported in the specified vSwitch. | 该交换机暂未开通ipv6地址。 |
400 | Ipv6AddressNotSupport | Ipv6 is not supported in specified region. | 当前地域还不支持IPV6地址。 |
400 | Ipv6AddressNotSupportInstanceType | IPv6 is not supported for the specified instance type. | 当前创建的规格不支持IPv6。 |
400 | EipPayInsufficientBalance | Your account does not have enough balance to purchase eip. | 当前账户余额不足以购买eip。 |
400 | EipPurchaseFlowControl | Request was denied due to eip frequent purchase. | 当前购买eip过于频繁,请稍后重试。 |
400 | Throttling | You have made too many requests within a short time; your request is denied due to request throttling | - |
400 | Throttling | You have made too many requests within a short time; your request is denied due to request throttling. | 短时间内请求过多。 |
400 | JobInstanceBatchCreateNotSupport | ECI job instance not support batch create | - |
400 | JobInstanceDiskNotSupport | ECI job instance not support disk volume | - |
400 | JobInstanceEipNotSupport | ECI job instance not support eip | - |
400 | JobInstanceFeatureNotMatch | ECI job instance feature not match | - |
400 | JobInstanceImageCacheNotSupport | ECI job instance not support image cache | - |
400 | JobInstanceIPv6NotSupport | ECI job instance not support IPv6 | - |
400 | JobInstanceRamRoleNotSupport | ECI job instance not support ram role | - |
400 | JobInstanceRegionNotSupport | ECI job instance not support in this region | - |
400 | JobInstanceSpotNotSupport | ECI job instance not support spot | - |
400 | LocalDiskAmountNotMatch | The amount of local volume is not matched with instance type. | 指定的规格与定义的本地盘存储卷数据不匹配,请确保指定的规格有足够的本地盘数量。 |
400 | InvalidInstanceTypeForEciSpotDurationBuy | Current instance type does not support spot duration instance. | 当前规格不支持eci自定义时长类型的spot实例。 |
400 | InvalidInstanceTypeForEciBuy | Sales of this current instance type is not supported in eci. | 当前规格不在eci售卖规格范围内。 |
400 | InstanceTypeNotMatchCpuArch | %s. | 您指定的ECS规格的CPU架构与您指定的CPU架构不匹配。 |
400 | JobInstanceEcsInstanceTypeNotSupport | Job-optimized elastic container instances cannot be created by specifying ECS instance types. | ECI Job优化型实例不支持指定ECS规格创建 |
400 | PrivatePoolInstanceSpotNotSupport | Spot is not supported for PrivatePool. | - |
400 | DryRun.Success | This request is a dryrun request with successful result. | 该dryrun请求校验已经通过。 |
400 | PrivateIpAddress.Already.InUse | The specific PrivateIpAddress already in use. | 私网ip地址已经被占用 |
400 | IncorrectOperation | %s | 当前的资源不支持该操作。 |
400 | FeatureBasedConstraintConflict | A conflict occurs in specified feature constraints: [%s]. | 指定的规格特性约束发生冲突 |
400 | OperationFailed.RiskControl | %s. | 我们检测到您的账号存在安全风险,详情请联系客服人员。 |
400 | RISK.RISK_CONTROL_REJECTION | To protect the security of your account, your request has been denied by the risk control system. Please contact Alibaba Cloud Customer Service for details. | 为保护您的账户安全,您的请求被风控系统拒绝,详情请联系客服。 |
403 | OperationDenied.VswZoneMisMatch | The specified VSwitchId is not in the specified Zone. | - |
403 | QuotaExceeded | %s quota exceeded. | 用户允许创建的实例已经超过限制。 |
403 | Zone.NotOnSale | The specified zone is not available for purchase. | 创建实例的可用区已经关闭售卖,请更换其他可用区。或者无法在该可用区使用指定 VPC 的虚拟交换机。 |
403 | Forbidden.RiskControl | This operation has been identified as an abnormal operation and cannot be processed. | 此操作已被确定为一个操作异常,无法处理。 |
403 | Forbidden.SubUser | The specified action is not available for you. | 当前用户无法执行该操作。 |
403 | Forbidden.OnlyForInvitedTest | Eci create action is only open to invited users during public beta. | Eci公测阶段只对受邀的用户开放。 |
403 | OperationDenied.SecurityGroupMisMatch | The specified VSwitchId and SecurityGroupId are not in the same VPC. | 指定的交换机和安全组不在同一个VPC下。 |
403 | InvalidVSwitchId.IpNotEnough | The specified VSwitch does not have enough IP addresses. | - |
403 | Forbidden.UserBussinessStatus | This operation is not allowed, because you have overdue bills. Pay the overdue bill and try again. | 用户处于欠费状态不允许创建,请充值后再尝试。 |
403 | Forbidden.UserNotRealNameAuthentication | This operation is not allowed, because you have not passed the real-name verification. | 操作被禁止,因为用户还未进行实名认证。 |
403 | InvalidUser.PassRoleForbidden | The RAM user is not authorized to assume a RAM role. | 子账号用户没有权限使用RAM实例角色。 |
403 | NoPermission | The RAM role does not belong to ECS. | - |
403 | OperationDenied.NoStock | Sales 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 | - |
403 | InvalidParameter.KMS.KeyId.Forbidden | You are not authorized to access the specified KMSKeyId. | 无权访问指定的 KMSKeyId。 |
403 | NoPermission | The RAM role AliyunECIContainerGroupRole does not belong to eci.aliyuncs.com. Please check and try again. | - |
403 | Forbidden.AccountClosed | The operation is forbidden. Your account has been closed. | 操作被禁止,因为用户账户已注销。 |
403 | InvalidOperation.ResourceManagedByCloudProduct | The operation is forbidden. The security group has been managed by another cloud product. | 安全组由其他云产品管理,禁止操作。 |
403 | Spot.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 | - |
403 | SecurityRisk.3DVerification | We have detected a security risk with your default credit or debit card. Please proceed with verification via the link in your email. | 我们检测到您的默认信用卡或借记卡存在安全风险。请通过电子邮件中的链接进行验证。 |
403 | CreateServiceLinkedRole.Denied | Please make sure the account has ram:CreateServiceLinkedRole permission. | 请确保账号拥有ram:CreateServiceLinkedRole权限。 |
403 | Throttling.Vcpu.PerDay | The maximum number of request for the day has been exceeded. | 当天的请求配额已经超出。 |
403 | OperationDenied.NoStock | Sales of this resource with specified features are temporarily suspended in the specified region; please check the instance type features and try again later. | 具有指定特征的资源在指定区域暂时停止销售;请检查与实例类型特征有关的参数,并稍后再试。 |
403 | FeatureAccessRestricted | Access to this feature:[%s] is restricted. Please contact Alibaba Cloud ECI support to request access. | 使用该特性需要申请白名单,请联系阿里云ECI团队申请加白。 |
404 | ImageSnapshot.NotFound | The specified snapshot does not exist. | 镜像缓存,快照不存在。 |
404 | InvalidDiskId.NotFound | The specified disk does not exist. | 指定的云盘不存在。 |
404 | InvalidParameter.KMS.KeyId.NotFound | The specified KMSKeyId does not exist. | 指定的参数“KMSKeyId”不存在。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-12-16 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-06-19 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-04-12 | OpenAPI 错误码发生变更 | 查看变更详情 |
2024-04-12 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-12-27 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-12-25 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-12-25 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-12-13 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-12-06 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-09-19 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-09-12 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-08-07 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-08-04 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-07-21 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-06-27 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-06-12 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-06-08 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-06-07 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-04-03 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
2023-03-30 | OpenAPI 错误码发生变更 | 查看变更详情 |