Call the CreateContainerGroup operation to create an ECI instance - Elastic Container Instance - Alibaba Cloud - Elastic Container Instance

Creates an Elastic Container Instance (ECI), which is a container group.

Operation description

When you call CreateContainerGroup to create an Elastic Container Instance (ECI), the system automatically creates a service-linked role named AliyunServiceRoleForECI to access related cloud services such as ECS and VPC. For more information, see Service-linked role for Elastic Container Instance.

When you create an ECI, you can configure features such as the instance, image, and storage as needed. For the parameters and descriptions related to each feature, see the following documentation:

Instance

ECI supports the following two methods to create an instance:

Both creation methods support the following features:

Image

Network

Storage

Container configuration

Logging and O&M

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eci:CreateContainerGroup

create

*ContainerGroup

acs:eci:{#regionId}:{#accountId}:containergroup/*

eci:tag

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
ZoneId	string	No	The zone to which the instance belongs. If this parameter is left empty, the system automatically selects a zone. Default value: empty.	cn-hangzhou-b
SecurityGroupId	string	No	The ID of the security group to which the instance belongs. Instances within the same security group can access each other. If you do not specify a security group, the system automatically uses the default security group in the selected region. You must ensure that the inbound rules of this security group include the protocols and ports that the container needs to expose. If no default security group exists in the region, the system performs automatic creation of a default security group and adds the declared container protocols and ports to the inbound rules of the security group.	sg-uf66jeqopgqa9hdn****
VSwitchId	string	No	The ID of the vSwitch to which the instance belongs. You can specify multiple vSwitch IDs. You can specify up to 10 vSwitch IDs at a time. Separate multiple vSwitch IDs with commas (,), for example, `vsw-*,vsw-`. If you do not specify a vSwitch, the system automatically uses the default vSwitch in the default VPC of the selected region. If no default VPC or default vSwitch exists in the region, the system performs automatic creation of a default VPC and a default vSwitch. Note* The number of IP addresses in the vSwitch CIDR block determines the maximum number of ECIs that can be created in the vSwitch. Plan the CIDR block in advance.	vsw-bp1xpiowfm5vo8o3c**,vsw-bp1rkyjgr1xwoho6k**
ContainerGroupName	string	Yes	The name of the Elastic Container Instance, which is the container group name. The name must meet the following requirements: The name must be 2 to 128 characters in length. The name can contain lowercase letters, digits, and hyphens (-). It cannot start or end with a hyphen.	nginx-test
RestartPolicy	string	No	The restart policy of the instance. Valid values: Always: Always restarts the instance. Never: Never restarts the instance. OnFailure: Restarts the instance only when it fails. Default value: Always.	Always
EipInstanceId	string	No	The ID of the Elastic IP Address (EIP).	eip-uf66jeqopgqa9hdn****
Cpu	number	No	The number of vCPUs at the instance level. Unit: cores.	1.0
Memory	number	No	The memory size at the instance level. Unit: GiB.	2.0
ResourceGroupId	string	No	The ID of the resource group.	rg-uf66jeqopgqa9hdn****
DnsPolicy	string	No	The DNS policy. Valid values: None: Uses the DNS settings specified in the DnsConfig field. Default: Inherits the DNS settings of the runtime environment.	Default
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must ensure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.	123e4567-xxxx-12d3-xxxx-426655440000
InstanceType	string	No	The ECS instance type. Multiple instance types are supported. For more information, see Create an instance by specifying an ECS instance type.	ecs.c5.xlarge
ImageSnapshotId	string	No	The ID of the image cache. For more information, see Use an image cache to accelerate instance creation.	imc-2zebxkiifuyzzlhl****
RamRoleName	string	No	The name of the RAM role for the instance. Elastic Container Instance and ECS share the same RAM role for instances. For more information, see Use an instance RAM role by calling API operations.	RamTestRole
TerminationGracePeriodSeconds	integer	No	The grace period for the program to handle operations before shutdown. Unit: seconds.	60
AutoMatchImageCache	boolean	No	Specifies whether to automatically match an image cache. Default value: false.	false
Ipv6AddressCount	integer	No	The number of IPv6 addresses. The value is fixed to 1, which indicates that an Elastic Container Instance can be assigned one IPv6 address.	1
ActiveDeadlineSeconds	integer	No	The validity period of the Elastic Container Instance. After this period expires, the instance is forcibly terminated. Unit: seconds.	1000
SpotStrategy	string	No	The preemption policy for the instance. Valid values: NoSpot: The instance is a regular pay-as-you-go instance. SpotWithPriceLimit: The instance is a spot instance with a maximum hourly price. SpotAsPriceGo: The instance is a spot instance whose price is automatically set by the system based on the current market price. Default value: NoSpot.	SpotWithPriceLimit
SpotPriceLimit	number	No	The maximum hourly price for the spot instance. The value can be accurate to three decimal places. You must specify this parameter when SpotStrategy is set to SpotWithPriceLimit.	0.025
ScheduleStrategy	string	No	The scheduling policy for the Elastic Container Instance when multiple zones are configured by specifying multiple vSwitches in the VSwitchId parameter. Valid values: VSwitchOrdered: Schedules the instance in sequential order. VSwitchRandom: Schedules the instance based on the optimal policy of Alibaba Cloud. For more information, see Configure multiple zones.	VSwitchOrdered
CorePattern	string	No	The custom directory for saving core files generated by coredump. For more information, see Save core files to a volume. Note The configured path cannot start with `\|`. You cannot configure an executable program through core dump.	/xx/xx/core
ShareProcessNamespace	boolean	No	Specifies whether to use a shared namespace. Default value: false.	false
AutoCreateEip	boolean	No	Specifies whether automatic creation of an EIP is enabled and whether to attach it to the Elastic Container Instance.	true
EipBandwidth	integer	No	The bandwidth of the EIP. Default value: 5 Mbit/s. You can specify this parameter when AutoCreateEip is set to true.	5
EipISP	string	No	The line type of the EIP. Valid values: BGP: BGP (Multi-ISP) line. This is the default value. BGP_PRO: BGP (Multi-ISP) Pro line.	BGP
EipCommonBandwidthPackage	string	No	The ID of the existing Internet Shared Bandwidth plan to attach.	cbwp-2zeukbj916scmj51m****
HostName	string	No	The hostname.	test
IngressBandwidth	integer	No	The inbound bandwidth limit. Unit: Bps.	1024000
EgressBandwidth	integer	No	The outbound bandwidth limit. Unit: Bps.	1024000
CpuOptionsCore	integer	No	The number of physical CPU cores. Only specific instance types support custom settings.	2
CpuOptionsThreadsPerCore	integer	No	The number of threads per core. Only specific instance types support custom settings. A value of 1 indicates that hyper-threading is disabled.	2
CpuOptionsNuma	string	No	This parameter is not supported.	1
EphemeralStorage	integer	No	The size of the additional temporary storage space. Unit: GiB. For more information, see Customize the size of temporary storage space.	20
Tag	array<object>	No	The list of tags. You can add up to 20 tags. For more information, see Use tags to manage instances.
	object	No	The list of tags. You can add up to 20 tags. For more information, see Use tags to manage instances.
Key	string	No	The tag key. If you specify this parameter, it cannot be an empty string and must be unique. The tag key can be up to 64 characters in length. It cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	version
Value	string	No	The tag value. If you specify this parameter, it can be an empty string. The tag value can be up to 128 characters in length. It cannot start with `acs:`, and cannot contain `http://` or `https://`.	3
ImageRegistryCredential	array<object>	No	The image repository information.
	object	No	The image repository information.
Password	string	No	The password for the image repository.	yourpassword
Server	string	No	The registry address of the image repository.	registry-vpc.cn-shanghai.aliyuncs.com
UserName	string	No	The username for the image repository.	yourusername
Container	array<object>	Yes	The container information.
	array<object>	No	The container information.
Arg	array	No	The arguments for the container startup command. A maximum of 10 arguments are supported.	100
	string	No	The arguments for the container startup command. A maximum of 10 arguments are supported.	100
Command	array	No	The container startup commands. A maximum of 20 commands are supported. Each command can contain up to 256 characters.	sleep
	string	No	The container startup commands. A maximum of 20 commands are supported. Each command can contain up to 256 characters.	sleep
Cpu	number	No	The number of vCPUs allocated to the container. Unit: cores.	0.25
EnvironmentVar	array<object>	No	The environment variables of the container.
	object	No	The environment variables of the container.
FieldRef.FieldPath	string	No	The reference to the environment variable value. Only status.podIP is supported.	status.podIP
Key	string	No	The name of the environment variable. The name must be 1 to 128 characters in length and can contain letters, digits, and underscores (_). It cannot start with a digit.	PATH
Value	string	No	The value of the environment variable. The value must be 0 to 256 characters in length.	/usr/local/bin
EnvironmentVarHide	boolean	No	Specifies whether to hide environment variable information when querying the details of the elastic container instance. Valid values: false: does not hide environment variable information. This is the default value. true: does not return environment variable information. Set this parameter to true to improve security when environment variables contain sensitive information.	false
Gpu	integer	No	The number of GPUs allocated to the container.	1
Image	string	Yes	The container image.	registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:latest
ImagePullPolicy	string	No	Pull image pull policy. Valid values: Always: always pulls pull image. IfNotPresent: pulls pull image only when pull image is not available locally. Never: never pulls pull image and uses only the local image.	Always
LifecyclePostStartHandlerExec	array	No	The command to execute in the container when the Settings for the postStart callback function are configured by using the command line.	["/bin/sh", "-c", "echo Hello from the postStart handler > /usr/share/message"]
	string	No	The command to execute in the container when the Settings for the postStart callback function are configured by using the command line.	["/bin/sh", "-c", "echo Hello from the postStart handler > /usr/share/message"]
LifecyclePostStartHandlerHttpGetHost	string	No	The host address that accepts the HTTP GET request when the Settings for the postStart callback function are configured by using an HTTP request.	10.0.XX.XX
LifecyclePostStartHandlerHttpGetHttpHeader	array<object>	No	The generated HTTP request header parameters.
	object	No	The generated HTTP request header parameters.
Name	string	No	The name of the custom field in the HTTP GET request header when you configure the Settings for the postStart callback function by using an HTTP request.	Xiao-Custom-Header
Value	string	No	The value of the custom field in the HTTP GET request header when you configure the Settings for the postStart callback function by using an HTTP request.	test-postStart
LifecyclePostStartHandlerHttpGetPath	string	No	The path to check by using the HTTP GET request when you configure the Settings for the postStart callback function by using an HTTP request.	/healthyz
LifecyclePostStartHandlerHttpGetPort	integer	No	The port number to check by using the HTTP GET request when you configure the Settings for the postStart callback function by using an HTTP request.	5050
LifecyclePostStartHandlerHttpGetScheme	string	No	The protocol type of the HTTP GET request when you configure the Settings for the postStart callback function by using an HTTP request. Valid values: HTTP HTTPS	HTTPS
LifecyclePostStartHandlerTcpSocketHost	string	No	The host address to check by using a TCP socket when you configure the Settings for the postStart callback function by using a TCP socket.	10.0.XX.XX
LifecyclePostStartHandlerTcpSocketPort	integer	No	The port to check by using a TCP socket when you configure the Settings for the postStart callback function by using a TCP socket.	80
LifecyclePreStopHandlerExec	array	No	The command to execute in the container when the Settings for the preStop callback function are configured by using the command line.	["/bin/sh", "-c","echo Hello from the preStop handler > /usr/share/message"]
	string	No	The command to execute in the container when the Settings for the preStop callback function are configured by using the command line.	["/bin/sh", "-c","echo Hello from the preStop handler > /usr/share/message"]
LifecyclePreStopHandlerHttpGetHost	string	No	The host address that accepts the HTTP GET request when the Settings for the preStop callback function are configured by using an HTTP request.	10.0.XX.XX
LifecyclePreStopHandlerHttpGetHttpHeader	array<object>	No	The generated HTTP request header parameters.
	object	No	The generated HTTP request header parameters.
Name	string	No	The name of the custom field in the HTTP GET request header when you configure the Settings for the preStop callback function by using an HTTP request.	Xiao-Custom-Header
Value	string	No	The value of the custom field in the HTTP GET request header when you configure the Settings for the preStop callback function by using an HTTP request.	test-preStop
LifecyclePreStopHandlerHttpGetPath	string	No	The path to check by using the HTTP GET request when you configure the Settings for the preStop callback function by using an HTTP request.	/healthyz
LifecyclePreStopHandlerHttpGetPort	integer	No	The port number to check by using the HTTP GET request when you configure the Settings for the preStop callback function by using an HTTP request.	88
LifecyclePreStopHandlerHttpGetScheme	string	No	The protocol type of the HTTP GET request when you configure the Settings for the preStop callback function by using an HTTP request. Valid values: HTTP HTTPS	HTTP
LifecyclePreStopHandlerTcpSocketHost	string	No	The host address to check by using a TCP socket when you configure the Settings for the preStop callback function by using a TCP socket.	10.0.XX.XX
LifecyclePreStopHandlerTcpSocketPort	integer	No	The port to check by using a TCP socket when you configure the Settings for the preStop callback function by using a TCP socket.	90
LivenessProbe.Exec.Command	array	No	The command to run in the container when the command line is used for health checks. Note When you configure the LivenessProbe parameters, you can select only one of the following check methods: HTTP GET, Exec, and TCP socket.
	string	No	The command to run in the container when the command line is used for health checks.	cat /tmp/healthy
LivenessProbe.FailureThreshold	integer	No	The minimum number of consecutive failures that are required to mark a health check as failed after a successful check. Default value: 3.	3
LivenessProbe.HttpGet.Path	string	No	The path to check by using the HTTP GET request when an HTTP request is used for health checks. Note When you configure the LivenessProbe parameters, you can select only one of the following check methods: HTTP GET, Exec, and TCP socket.	/healthz
LivenessProbe.HttpGet.Port	integer	No	The port number to check by using the HTTP GET request when an HTTP request is used for health checks. Note When you configure the LivenessProbe parameters, you can select only one of the following check methods: HTTP GET, Exec, and TCP socket.	8888
LivenessProbe.HttpGet.Scheme	string	No	The protocol type of the HTTP GET request when an HTTP request is used for health checks. Valid values: HTTP HTTPS Note When you configure the LivenessProbe parameters, you can select only one of the following check methods: HTTP GET, Exec, and TCP socket.	HTTP
LivenessProbe.InitialDelaySeconds	integer	No	The number of seconds to wait before the first health check is performed after the container starts.	5
LivenessProbe.PeriodSeconds	integer	No	The interval between health checks. Default value: 10. Minimum value: 1. Unit: seconds.	5
LivenessProbe.SuccessThreshold	integer	No	The minimum number of consecutive successes that are required to mark a health check as successful after a failed check. Default value: 1. The value must be 1.	1
LivenessProbe.TcpSocket.Port	integer	No	The port to check by using a TCP socket when a TCP socket is used for health checks. Note When you configure the LivenessProbe parameters, you can select only one of the following check methods: HTTP GET, Exec, and TCP socket.	8080
LivenessProbe.TimeoutSeconds	integer	No	The timeout period for a health check. Default value: 1. Minimum value: 1. Unit: seconds.	1
Memory	number	No	The memory size of the container. Unit: GiB.	0.5
Name	string	Yes	The name of the container.	nginx
Port	array<object>	No	The port number.
	object	No	The port number.
Port	integer	No	The port number. Valid values: 1 to 65535.	80
Protocol	string	No	The protocol type. Valid values: TCP UDP	TCP
ReadinessProbe.Exec.Command	array	No	The command to run in the container when the command line is used for health checks. Note When you configure the ReadinessProbe parameters, you can select only one of the following check methods: HTTP GET, Exec, and TCP socket.
	string	No	The command to run in the container when the command line is used for health checks.	cat /tmp/healthy
ReadinessProbe.FailureThreshold	integer	No	The minimum number of consecutive failures that are required to mark a health check as failed after a successful check. Default value: 3.	3
ReadinessProbe.HttpGet.Path	string	No	The path to check by using the HTTP GET request when an HTTP request is used for health checks. Note When you configure the ReadinessProbe parameters, you can select only one of the following check methods: HTTP GET, Exec, and TCP socket.	/healthz
ReadinessProbe.HttpGet.Port	integer	No	The port number to check by using the HTTP GET request when an HTTP request is used for health checks. Note When you configure the ReadinessProbe parameters, you can select only one of the following check methods: HTTP GET, Exec, and TCP socket.	8080
ReadinessProbe.HttpGet.Scheme	string	No	The protocol type of the HTTP GET request when an HTTP request is used for health checks. Valid values: HTTP HTTPS Note When you configure the ReadinessProbe parameters, you can select only one of the following check methods: HTTP GET, Exec, and TCP socket.	HTTP
ReadinessProbe.InitialDelaySeconds	integer	No	The number of seconds to wait before the first health check is performed after the container starts.	3
ReadinessProbe.PeriodSeconds	integer	No	The interval between health checks. Default value: 10. Minimum value: 1. Unit: seconds.	3
ReadinessProbe.SuccessThreshold	integer	No	The minimum number of consecutive successes that are required to mark a health check as successful after a failed check. Default value: 1. The value must be 1.	1
ReadinessProbe.TcpSocket.Port	integer	No	The port to check by using a TCP socket when a TCP socket is used for health checks. Note When you configure the ReadinessProbe parameters, you can select only one of the following check methods: HTTP GET, Exec, and TCP socket.	8000
ReadinessProbe.TimeoutSeconds	integer	No	The timeout period for a health check. Default value: 1. Minimum value: 1. Unit: seconds.	1
SecurityContext.Capability.Add	array	No	The specific permissions granted to processes in the container. Only NET_ADMIN and NET_RAW are supported. Note NET_RAW is not supported by default. To use NET_RAW, submit a ticket.
	string	No	The specific permissions granted to processes in the container. Only NET_ADMIN and NET_RAW are supported. Note NET_RAW is not supported by default. To use NET_RAW, submit a ticket.	NET_ADMIN
SecurityContext.ReadOnlyRootFilesystem	boolean	No	Specifies whether the root file system of the container is read-only. Only true is supported.	true
SecurityContext.RunAsUser	integer	No	The user ID used to run the container.	1000
SecurityContextPrivileged	boolean	No	Specifies whether to run the container in privileged mode. Valid values: true: runs the container in privileged mode. false: does not run the container in privileged mode. This is the default value. Note The privileged container feature is in invitational preview. To use this feature, submit a ticket.	true
SecurityContextRunAsGroup	integer	No	The user group used to run the container.	3000
SecurityContextRunAsNonRoot	boolean	No	Specifies whether to run the container as a non-root user. Valid values: true: runs the container as a non-root user. false: runs the container as the root user. This is the default value.	true
Stdin	boolean	No	Specifies whether to allocate a buffer for standard input during container runtime. If this parameter is not specified, reading from standard input in the container results in an EOF error. Default value: false.	false
StdinOnce	boolean	No	Specifies whether the standard input stream maintains the enabling status across multiple attached sessions when standard input is true. If StdinOnce is set to true, standard input is opened when the container starts, remains empty until the first client attaches to it, and then maintains the enabling status to accept data until the client disconnects. At this point, standard input enters shutdown and remains in shutdown until the container restarts.	false
TerminationMessagePath	string	No	The path for the termination message of the container.	/tmp/termination-log
TerminationMessagePolicy	string	No	The message notification policy. Default value: empty. Currently, only message notifications from MSMQ are supported.	FallbackToLogsOnError
Tty	boolean	No	Specifies whether to enable interactive mode. Default value: false. Set this parameter to true when Command is set to /bin/bash.	false
VolumeMount	array<object>	No	The volume mount information.
	object	No	The volume mount information.
MountPath	string	No	The directory where the volume is mounted in the container. Note The contents of the container mount path are directly overwritten by the contents of the volume. Proceed with caution.	/pod/data
MountPropagation	string	No	The mount propagation setting of the volume. Mount propagation allows a volume mounted by a container to be shared with other containers in the same pod, or even with other pods on the same node. Valid values: None: The volume is unaware of any subsequent mount operations performed on this volume or its subdirectories. HostToContainer: The volume is aware of all subsequent mount operations performed on this volume or its subdirectories. Bidirectional: Similar to HostToContainer, the volume is aware of mount operations. In addition, the volume is propagated back to the host and to all containers of all pods that use the same volume. Default value: None.	None
Name	string	No	The name of the volume. This must be the same as the Name in Volume.	default-volume1
ReadOnly	boolean	No	Specifies whether the volume is read-only. Default value: false.	false
SubPath	string	No	The subpath of the volume.	data2/
WorkingDir	string	No	The working directory of the container.	/usr/local/
Volume	array<object>	No	The volume mount information.
	array<object>	No	The volume mount information.
ConfigFileVolume.ConfigFileToPath	array<object>	No	The information about the ConfigFile volume. If multiple ConfigFileToPath items are configured, the total length of the corresponding Content values cannot exceed 60 KB.
	object	No	The information about the ConfigFile volume.
Content	string	No	The content of the configuration file. The content must be Base64-encoded. A single configuration file cannot exceed 32 KB in size.	bGl1bWk=
Mode	integer	No	The permissions of the configuration file. If this parameter is not specified, the value of ConfigFileVolume.DefaultMode is used. The permissions are represented by a four-digit octal number. For example, 0644 indicates that the permissions are rw-r--r--, which means the user has read and write permissions, the group has read permissions, and others have read permissions. Permission description: `---`: No permissions. The octal value is 0. `--x`: Execute permission only. The octal value is 1. `-w-`: Write permission only. The octal value is 2. `-wx`: Write and execute permissions. The octal value is 3. `r--`: Read permission only. The octal value is 4. `r-x`: Read and execute permissions. The octal value is 5. `rw-`: Read and write permissions. The octal value is 6. `rwx`: Read, write, and execute permissions. The octal value is 7.	0644
Path	string	No	The relative path of the configuration file relative to the mount directory.	test/config-test.cnf
ConfigFileVolume.DefaultMode	integer	No	The default permissions of the ConfigFile volume.	0644
DiskVolume.DiskId	string	No	The ID of the disk volume.	d-xx
DiskVolume.DiskSize	integer	No	The size of the disk volume. Unit: GiB.	15
DiskVolume.FsType	string	No	The file system type of the disk volume.	xfs
EmptyDirVolume.Medium	string	No	The storage medium of the emptyDir volume. By default, this parameter is empty and the node file system is used. If you set this parameter to memory, the memory is used.	memory
EmptyDirVolume.SizeLimit	string	No	The size of the emptyDir volume. Unit: GiB.	2
FlexVolume.Driver	string	No	The driver type used when you use the FlexVolume plugin to mount a volume. Valid values: alicloud/disk: mounts a cloud disk. alicloud/nas: mounts a NAS file system. alicloud/oss: mounts an OSS bucket.	alicloud/disk
FlexVolume.FsType	string	No	The type of the file system to be mounted. The default value depends on the script of the FlexVolume.	ext4
FlexVolume.Options	string	No	The list of options for the FlexVolume object. The options are passed as key-value pairs in JSON format. For example, when you mount a cloud disk by using FlexVolume, Options specifies the configuration parameters of the cloud disk. You can configure the following parameters: volumeId: the ID of the existing cloud disk. volumeSize: the size of the cloud disk. Unit: GiB. Valid values: 20 to 32768. performanceLevel: the performance level of the cloud disk. For more information, see Cloud disk performance levels. deleteWithInstance: specifies whether to release the cloud disk when the instance is released. Default value: false. encrypted: specifies whether to encrypt the cloud disk. Default value: false. For more information, see Encryption overview. kmsKeyId: the ID of the KMS key used to encrypt the cloud disk.	{"volumeId":"d-2zehdahrwoa7srg****","performanceLevel": "PL2"}
HostPathVolume.Path	string	No	The directory path of the hostPath volume on the host.	/pod/data
HostPathVolume.Type	string	No	The type of the hostPath volume. Valid values: Directory: a directory. File: a file. Note The hostPath volume is available only to whitelisted users.	Directory
NFSVolume.Path	string	No	The path of the NFS volume.	/share
NFSVolume.ReadOnly	boolean	No	Specifies whether the NFS volume is read-only. Default value: false.	false
NFSVolume.Server	string	No	The address of the NFS server.	3f9cd4a596-naw76.cn-shanghai.nas.aliyuncs.com
Name	string	No	The name of the volume.	default-volume1
Type	string	No	The type of the volume. Valid values: EmptyDirVolume: an emptyDir volume, which represents an empty directory. NFSVolume: an NFS volume, which represents a network file system. ConfigFileVolume: a ConfigFile volume, which represents a configuration file. FlexVolume: uses the FlexVolume plugin to extend storage types and supports mounting cloud disks. HostPathVolume: a hostPath volume, which represents a file or directory on the host node. This type is available only to whitelisted users. DiskVolume (not recommended): a cloud disk volume. We recommend that you use FlexVolume to mount cloud disks.	ConfigFileVolume
InitContainer	array<object>	No	The list of init containers.
	array<object>	No	The list of init containers.
Arg	array	No	The startup arguments of the container.	10
	string	No	The startup arguments of the container.	10
Command	array	No	The startup commands of the container.	sleep
	string	No	The startup commands of the container.	sleep
Cpu	number	No	The number of vCPUs allocated to the container. Unit: cores.	0.5
EnvironmentVar	array<object>	No	The list of environment variables for the container.
	object	No	The list of environment variables for the container.
FieldRef.FieldPath	string	No	The reference to the environment variable value. Only status.podIP is supported.	status.podIP
Key	string	No	The name of the environment variable. The name must be 1 to 128 characters in length and can contain letters, digits, and underscores (_). It cannot start with a digit.	Path
Value	string	No	The value of the environment variable. The value must be 0 to 256 characters in length.	/usr/bin/
Gpu	integer	No	The number of GPUs allocated to the container.	1
Image	string	No	The image used by the container.	nginx
ImagePullPolicy	string	No	Pull image pull policy. Valid values: Always: always pulls pull image. IfNotPresent: pulls pull image on demand. The local image is used first. If no local image is available, pull image is pulled. Never: never pulls pull image. The local image is used.	Always
Memory	number	No	The memory size of the container. Unit: GiB.	1.0
Name	string	No	The name of the container.	test-init
Port	array<object>	No	The port number of the init container.
	object	No	The port number of the init container.
Port	integer	No	The port number. Valid values: 1 to 65535.	8888
Protocol	string	No	The protocol type. Valid values: TCP UDP	TCP
SecurityContext.Capability.Add	array	No	The specific permissions granted to processes in the container. Only NET_ADMIN and NET_RAW are supported. Note NET_RAW is not supported by default. To use NET_RAW, submit a ticket.
	string	No	The specific permissions granted to processes in the container. Only NET_ADMIN and NET_RAW are supported. Note NET_RAW is not supported by default. To use NET_RAW, submit a ticket.	NET_ADMIN
SecurityContext.ReadOnlyRootFilesystem	boolean	No	Specifies whether the root file system of the container is read-only. Currently, you can only set this parameter to true.	true
SecurityContext.RunAsUser	integer	No	The user ID used to run the container.	587
TerminationMessagePath	string	No	The source of the termination message when the container exits. When the container exits, the termination message is retrieved from the specified termination message file.	/tmp/termination-log
TerminationMessagePolicy	string	No	The mount information. Default value: empty.	*****
VolumeMount	array<object>	No	The list of volume mount information.
	object	No	The list of volume mount information.
MountPath	string	No	The mount directory. The content in the mount directory of the container is directly overwritten by the content of the volume. Use this parameter with caution.	/usr/share/
MountPropagation	string	No	The mount propagation setting of the volume. Mount propagation allows a volume mounted by a container to be shared with other containers in the same pod, or even with other pods on the same node. Valid values: None: The volume is unaware of any subsequent mount operations performed on this volume or its subdirectories. HostToContainer: The volume is aware of all subsequent mount operations performed on this volume or its subdirectories. Bidirectional: Similar to HostToContainer, the volume is aware of mount operations. In addition, the volume is propagated back to the host and to all containers of all pods that use the same volume. Default value: None.	None
Name	string	No	The name of the volume to be mounted.	test-empty
ReadOnly	boolean	No	Specifies whether the mount path is read-only. Default value: false.	false
SubPath	string	No	The subdirectory under the volume. This allows a pod to mount different directories under the same volume to different directories in the container.	/usr/sub/
WorkingDir	string	No	The working directory.	/usr/local
DnsConfig.NameServer	array	No	The list of IP addresses of DNS servers.	172.10..*
	string	No	The list of IP addresses of DNS servers.	172.10..*
DnsConfig.Search	array	No	The list of DNS search domains.	svc.local.kubenetes
	string	No	The list of DNS search domains.	svc.local.kubernetes
DnsConfig.Option	array<object>	No	The list of options for the object.
	object	No	The list of options for the object.
Name	string	No	The name of the object.	name
Value	string	No	The value of the object.	value
HostAliase	array<object>	No	Adds an alias for the elastic container instance.
	object	No	Adds an alias for the elastic container instance.
Hostname	array	No	The hostname to be added.	hehe.com
	string	No	The hostname to be added.	hehe.com
Ip	string	No	The IP address to be added.	1.1.1.1
SecurityContext.Sysctl	array<object>	No	Modifies secure sysctl parameters through the security context. For more information, see Configure a security context.
	object	No	Modifies secure sysctl parameters through the security context. For more information, see Configure a security context.
Name	string	No	The name of the secure sysctl parameter to be modified through the security context. Valid values: net.ipv4.ping_group_range net.ipv4.ip_unprivileged_port_start	net.ipv4.ping_group_range
Value	string	No	The value of the secure sysctl parameter to be modified through the security context.	65536
HostSecurityContext.Sysctl	array<object>	No	Modifies unsafe sysctl parameters through the security context. For more information, see Configure a security context.
	object	No	Modifies unsafe sysctl parameters through the security context. For more information, see Configure a security context.
Name	string	No	The name of the unsafe sysctl parameter to be modified through the security context. Valid values: kernel.shm* (except kernel.shm_rmid_forced) kernel.msg* kernel.sem fs.mqueue.* net.* (except net.ipv4.tcp_syncookies, net.ipv4.ping_group_range, and net.ipv4.ip_unprivileged_port_start)	kernel.msgmax
Value	string	No	The value of the unsafe sysctl parameter to be modified through the security context.	65536
NtpServer	array	No	The NTP server.	ntp.cloud.aliyuncs.com
	string	No	The NTP server.	ntp.cloud.aliyuncs.com
AcrRegistryInfo	array<object>	No	The list of ACR Enterprise instance information. For more information, see Pull ACR images without a password.
	object	No	The list of ACR Enterprise instance information.
ArnService	string	No	The ARN of the RAM role in the account that has resource ownership of resources such as the ECI instance.	acs:ram::1609982529******:role/role-assume
ArnUser	string	No	The ARN of the RAM role in the account to which the ACR instance belongs.	acs:ram::1298452580******:role/role-acr
Domain	array	No	The domain name of the ACR Enterprise instance. By default, all domain names of the instance are used. You can specify specific domain names and separate multiple domain names with commas (,).	***-**-registry.cn-beijing.cr.aliyuncs.com
	string	No	The domain name of the ACR Enterprise instance. By default, all domain names of the instance are used. You can specify specific domain names and separate multiple domain names with commas (,).	***-**-registry.cn-beijing.cr.aliyuncs.com
InstanceId	string	No	The instance ID of the ACR Enterprise instance.	cri-nwj395hgf6f3****
InstanceName	string	No	The name of the ACR Enterprise instance.	acr-test
RegionId	string	No	The region ID of the ACR Enterprise instance.	cn-beijing
SpotDuration	integer	No	The protection period of the spot instance. Unit: hours. Default value: 1. A value of 0 indicates that no protection period is configured.	1
StrictSpot	boolean	No	Specifies whether to run the task periodically. Valid values: true: Runs the task periodically. false: Does not run the task periodically.	true
PlainHttpRegistry	string	No	The address of the self-pull image repository. When you create an ECI instance by using an image from a self-pull image repository that uses the HTTP protocol, you must configure this parameter so that ECI uses the HTTP protocol to pull the image. This prevents image pull failures caused by protocol mismatches.	"harbor*.pre.com,192.168.XX.XX:5000,reg*.test.com:80"
InsecureRegistry	string	No	The address of the self-managed image repository. When you create an ECI instance by using an image from a self-managed image repository that uses a self-signed certificate, you must configure this parameter to skip certificate verification. This prevents image pull failures caused by certificate verification failures.	"harbor*.pre.com,192.168.XX.XX:5000,reg*.test.com:80"
ImageAccelerateMode	string	No	The image acceleration mode. Valid values: nydus: Uses Nydus for acceleration. The image must support Nydus. dadi: Uses DADI for acceleration. The image must support DADI. p2p: Uses P2P for acceleration. The image must support P2P. imc: Uses image cache for acceleration.	imc
Ipv6GatewayBandwidthEnable	boolean	No	Specifies whether to enable IPv6 Internet communication for the ECI instance.	true
Ipv6GatewayBandwidth	string	No	The peak Internet bandwidth of the IPv6 address. This parameter is required when Ipv6GatewayBandwidthEnable is set to true. Valid values: If the Billable methods for the Internet bandwidth of the IPv6 gateway are pay-by-bandwidth billing, the Internet bandwidth of the IPv6 address ranges from 1 to 2000 Mbit/s. If the Billable methods for the Internet bandwidth of the IPv6 gateway are pay-by-traffic billing, the Internet bandwidth of the IPv6 address is subject to the gateway specifications. If the gateway is the Free Edition, the Internet bandwidth of the IPv6 address ranges from 1 to 200 Mbit/s. If the gateway is the Enterprise Edition, the Internet bandwidth of the IPv6 address ranges from 1 to 500 Mbit/s. If the gateway is the Enhanced Enterprise Edition, the Internet bandwidth of the IPv6 address ranges from 1 to 1000 Mbit/s. Default value: the maximum value of the bandwidth range corresponding to the gateway.	100
ContainerResourceView	boolean	No	Specifies whether to enable the container resource view. When the ECI instance type is larger than the requested instance type, you can enable this feature to ensure that the resources visible in the container match the requested resources.	false
FixedIp	string	No	Specifies whether to enable a fixed IP address for the instance. A value of true indicates that a fixed IP address is enabled. For more information, see Configure a fixed IP address for an ECI instance.	true
FixedIpRetainHour	integer	No	The retention period of the fixed IP address after it becomes idle. This is the retention period of the fixed IP address after the instance with the fixed IP address is released. Unit: hours. Default value: 48.	24
DataCacheBucket	string	No	The data cache bucket.	default
DataCachePL	string	No	The performance level of the cloud disk used for data cache. ESSD cloud disks are preferred. Default value: PL1.	PL1
DataCacheProvisionedIops	integer	No	The provisioned read and write IOPS of the ESSD AutoPL cloud disk when the data cache uses an ESSD AutoPL cloud disk. Valid values: 0 to min{50000, 1000 × Capacity - Baseline performance}. Baseline performance = min{1800 + 50 × Capacity, 50000}. For more information, see ESSD AutoPL cloud disks.	40000
DataCacheBurstingEnabled	boolean	No	Specifies whether to enable the burst feature for the ESSD AutoPL cloud disk when the data cache uses an ESSD AutoPL cloud disk. For more information, see ESSD AutoPL cloud disks.	false
DryRun	boolean	No	Specifies whether to only precheck the request. Valid values: true: Sends a check request and does not create the ECI instance. The check items include whether required parameters are specified, the request format, service limits, and inventory. If the check fails, the corresponding error is returned. If the check succeeds, the DryRun.Success error code is returned. false (default): Sends a normal request and directly creates the ECI instance after the check succeeds.	false
PrivateIpAddress	string	No	The private IP address of the ECI instance. Only IPv4 addresses are supported. Make sure that the IP address is not in use.	172.16.0.1
OsType	string	No	The operating system of the ECI instance. Valid values: Linux (default) Windows Note Windows instances are in invitational preview. To use Windows instances, submit a ticket.	Windows
CpuArchitecture	string	No	The CPU architecture of the ECI instance. Valid values: AMD64 (default) ARM64	ARM64
ComputeCategory	array	No	The computing power category. For more information, see Specify a computing power category to create an instance.
	string	No	The computing power category. Valid values: economy: Economy general: General-purpose You can specify multiple computing power categories. The system creates the instance based on the specified order.	economy
GpuDriverVersion	string	No	The GPU driver version. Note Only specific instance types support switching the GPU driver version. For more information, see Specify a GPU instance type to create an instance.	tesla=535
MaxPendingMinute	integer	No

Response elements

Element	Type	Description	Example
	object
ContainerGroupId	string	The instance ID, which is the container group ID.	eci-uf6fonnghi50u374****
RequestId	string	The request ID, which uniquely identifies the request.	89945DD3-9072-47D0-A318-353284CFC7B3

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	Account.Arrearage	Your account has an outstanding payment.	Your account has an outstanding payment.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	Request validation has been passed with DryRun flag set.
400	InvalidParameter.CPU.Memory	The specified cpu and memory are not allowed
400	InvalidParameter.DuplicatedName	The container group include containers with duplicate names.	The container group contains containers with duplicate names.
400	InvalidParameter.DuplicatedVolumeName	The container group includes volumes with duplicate names.	The container group includes volumes with duplicate names.
400	IncorrectStatus	%s	The specified instance status is invalid.
400	ServiceNotEnabled	%s	The service on which this request depends has not been activated. Please activate and try again.
400	ImageSnapshot.IncorrectStatus	%s	The status of the specified snapshot is invalid.
400	ImageSnapshot.NotSupport	%s	Image caching based on data disk snapshots is not available for all users. If you want to enable this function, contact us.
400	DiskVolume.NotSupport	The disk volume is not supported.	Disk volume does not support your structure. If you want to enable this function, contact us.
400	RamRole.NotSupport	The RAM role is not supported.	The RAM role is not supported.
400	DiskNumber.LimitExceed	The maximum number of disks in an instance is exceeded.	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.	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.	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.	You need to apply to be added to the whitelist of the specified CPU and memory.
400	RecommendEmpty.InstanceTypeFamilyNotMatched	The recommended instance type is unavailable in the current zone. Try again later.	No recommended instance types are available in the current zone. Try again later or create instances in another zone.
400	LocalDiskAmountNotMatch	The number of local volumes does not match the instance type.	The number of local disks does not match the instance type.
400	Payfor.CreditPayInsufficientBalance	Your payment credit line is insufficient.	Your payment credit line is insufficient.
400	InvalidOperation.KMS.InstanceTypeNotSupport	The specified instance is invalid. Only I/O optimized instances support KMS key.	The specified instance is invalid. Only I/O optimized instances support KMS key.
400	InvalidParameter.Encrypted.KmsNotEnabled	KMS must be enabled for encrypted disks.	Encrypted cloud disks require Key Management Service to be enabled.
400	InvalidParameter.KMS.EncryptedIllegal	After configuring the parameter KmsKeyId, you must enable encryption.	After configuring the parameter KmsKeyId, you must enable encryption.
400	InvalidSpotCpuMemorySpec	The specified CPU and memory are not allowed. You must create spot ECI using standard ECS specifications for CPU and memory.	A standard ECS instance type must be used to create a spot elastic container instance.
400	Ipv6AddressNotSupportVsw	IPv6 is not supported in the specified vSwitch.	The vSwitch does not have IPv6 enabled.
400	Ipv6AddressNotSupport	Ipv6 is not supported in specified region.	The current region does not support IPv6 addresses.
400	Ipv6AddressNotSupportInstanceType	IPv6 is not supported for the specified instance type.	The specified instance type does not support IPv6.
400	EipPayInsufficientBalance	Your account does not have enough balance to purchase eip.	The current account balance is insufficient to purchase an EIP.
400	EipPurchaseFlowControl	Request was denied due to eip frequent purchase.	EIP purchases are too frequent. Try again later.
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	InvalidInstanceTypeForEciSpotDurationBuy	Current instance type does not support spot duration instance.	The specified instance type does not support spot instances with custom duration.
400	InvalidInstanceTypeForEciBuy	Sales of this current instance type is not supported in eci.	The specified instance type is not within the range of container group types available for sale.
400	InstanceTypeNotMatchCpuArch	%s.	The CPU architecture of the specified ECS instance type does not match the specified CPU architecture.
400	JobInstanceEcsInstanceTypeNotSupport	Job-optimized elastic container instances cannot be created by specifying ECS instance types.	Job-optimized container group instances do not support creation with a specified ECS instance type.
400	PrivatePoolInstanceSpotNotSupport	Spot is not supported for PrivatePool.
400	DryRun.Success	This request is a dryrun request with successful result.	The dry run request has passed validation.
400	PrivateIpAddress.Already.InUse	The specific PrivateIpAddress already in use.	The private IP address is already in use.
400	IncorrectOperation	%s	You cannot perform this operation on the specified resource.
400	FeatureBasedConstraintConflict	A conflict occurs in specified feature constraints: [%s].	A conflict occurs in specified feature constraints
400	OperationFailed.RiskControl	%s.	We have detected that your account has security risks. Please contact customer service personnel for details.
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.	In order to protect the security of your account, your request was rejected by the wind control system. Please contact customer service for details.
400	InvalidInstanceTypeForRaid	%s.	The current specification does not support Raid.
400	RegionDissolved	%s.	Alibaba Cloud is scheduled to make adjustments in this region. ECI service in this region will be suspended.
400	MultiAttachedCloudDiskNotSupport	%s.	You cannot mount a cloud disk with the multi-mount function enabled (that is, an NVMe shared disk).
400	InvalidParameter.ValueExceeded	ecs instance type or vcpu quota exceeded.	Specifications exceed the specified quota range
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.	The zone in which you want to create the instance is no longer available for purchase. Use a different zone, or the vSwitch of the specified VPC cannot be used in this zone.
403	Forbidden.RiskControl	This operation has been identified as an abnormal operation and cannot be processed.	This operation has been identified as abnormal 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.
403	OperationDenied.SecurityGroupMisMatch	The specified VSwitchId and SecurityGroupId are not in the same 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.	The operation is forbidden because the account has an overdue payment. Top up your account and try again.
403	Forbidden.UserNotRealNameAuthentication	This operation is not allowed, because you have not passed the real-name verification.	The operation is forbidden because the user has not completed real-name verification.
403	InvalidUser.PassRoleForbidden	The RAM user is not authorized to assume a RAM role.	The RAM user is not authorized to assume a RAM role.
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://www.alibabacloud.com/help/document_detail/157290.html
403	InvalidParameter.KMS.KeyId.Forbidden	You are not authorized to access the specified KMSKeyId.	You are not authorized to access the specified KMSKeyId.
403	Forbidden.AccountClosed	The operation is forbidden. Your account has been closed.	The operation is forbidden because the user account has been deregistered.
403	InvalidOperation.ResourceManagedByCloudProduct	The operation is forbidden. The security group has been managed by another cloud product.	The security group is managed by another cloud service and cannot be modified.
403	Spot.NotMatched	%s. We recommend that you use the create multi-zone function to avoid insufficient inventory. For more information, see https://www.alibabacloud.com/help/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.	A security risk has been detected on your default credit or debit card. Verify your card by using the link in the email.
403	CreateServiceLinkedRole.Denied	Please make sure the account has ram:CreateServiceLinkedRole permission.	Please make sure the account has ram:CreateServiceLinkedRole permission.
403	Throttling.Vcpu.PerDay	The maximum number of request for the day has been exceeded.	The maximum number of request for the day has been exceeded.
403	FeatureAccessRestricted	Access to this feature:[%s] is restricted. Please contact Alibaba Cloud ECI support to request access.	Access to this feature is restricted. Please contact Alibaba Cloud ECI support to request access.
404	ImageSnapshot.NotFound	The specified snapshot does not exist.	The snapshot for the image cache does not exist.
404	InvalidDiskId.NotFound	The specified disk does not exist.	The specified cloud disk does not exist.
404	InvalidParameter.KMS.KeyId.NotFound	The specified KMSKeyId does not exist.	The specified KMSKeyId does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.