DescribeContainerGroups - Elastic Container Instance - Alibaba Cloud Documentation Center

Queries information about multiple elastic container instances at a time.

Operation description

After an elastic container instance is terminated, its underlying computing resources are recycled. By default, other resources, such as elastic IP addresses (EIPs), that are created together with the instance are released together with the instance.
The metadata of an instance in the final status (Failed, Succeeded, or Expired) is retained based on the following rules:
- All metadata information is retained within 1 hour since the instance enters the final status.
- One hour after the instance enters the final status, only the latest 100 entries of metadata information in each region are retained.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
eci:DescribeContainerGroups	get	ContainerGroup `acs:eci:{#regionId}:{#accountId}:containergroup/` *ContainerGroup `acs:eci:{#regionId}:{#accountId}:containergroup/{#containergroupId}`	eci:tag	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance.	cn-hangzhou
ZoneId	string	No	The ID of the zone in which the elastic container instances are deployed. If you do not specify this parameter, the system selects a zone. This parameter is empty by default.	cn-hangzhou-h
VSwitchId	string	No	The ID of the vSwitch to which the elastic container instances are connected.	vsw-bp1jrgfqqy54kg5hc****
NextToken	string	No	The token that determines the start point of the query. If this parameter is left empty, all results have been returned. Note You do not need to specify this parameter in the first request. Starting from the second request, you can obtain the token from the result returned by the previous request.	d78f2dd8-5979-42fe-****-b16db43be5bc
Limit	integer	No	The maximum number of resources to return. Default value: 20. Maximum value: 20. Note The number of returned resources is less than or equal to the specified number.	20
ContainerGroupIds	string	No	The IDs of the elastic container instances in JSON format. You can specify up to 20 IDs.	["eci-bp17gw49eu09yiwm**", "eci-bp19aq49du01abcm", "eci-2zegym1qhbmdfr1s**"]
ContainerGroupName	string	No	The name of the elastic container instance.	test
Status	string	No	The status of the elastic container instance. Valid values: Pending: The instance is being started. Running: The instance is running. Succeeded: The instance runs successfully. Failed: The instance fails to run. Scheduling: The instance is being created. ScheduleFailed: The instance fails to be created. Restarting: The instance is being restarted. Updating: The instance is being updated. Terminating: The instance is being terminated. Expired: The instance expires.	Running
ResourceGroupId	string	No	The ID of the resource group to which the instance belongs.	rg-aekzh43v*****
WithEvent	boolean	No	Specify whether to return event information.	true
Tag	array<object>	No	The tag of the instances.
	object	No	The tag of the instances.
Key	string	No	The tag key of the instances.	name
Value	string	No	The tag value of the instances.	test
ComputeCategory	string	No	The compute category of the instance. Valid values: economy general	economy
SecurityGroupId	string	No	The ID of the security group to which the instance belongs.	sg-uf66jeqopgqa9hdn****

Response parameters

Parameter	Type	Description	Example
	object
TotalCount	integer	The number of queried instances.	1
NextToken	string	The token that determines the start point of the query.	d78f2dd8-5979-42fe-****-b16db43be5bc
RequestId	string	The ID of the request. The value is unique.	89945DD3-9072-47D0-A318-353284CFC7B3
ContainerGroups	array<object>	Details about the queried elastic container instances.
ContainerGroup	object	Details about the queried elastic container instance.
Status	string	The status of the instance. Valid values: Pending: The instance is being started. Running: The instance is running. Succeeded: The instance successfully runs. Failed: The instance fails to run. Scheduling: The instance is being created. ScheduleFailed: The instance fails to be created. Restarting: The instance is being restarted. Updating: The instance is being updated. Terminating: The instance is being terminated. Expired: The instance is expired.	Running
CreationTime	string	The time when the instance was created. The time follows the RFC 3339 standard. The time is displayed in UTC.	2018-08-02T15:00:00Z
VpcId	string	The ID of the VPC to which the instance belongs.	vpc-1vzjjflab6wvjox****
InternetIp	string	The public IP address.	192.0.XX.XX
TenantSecurityGroupId	string	This parameter is not publicly available.	sg-xxx
SecurityGroupId	string	The ID of the security group to which the instances belong.	sg-bp12ujq5zpxuyjfo3o8r
HostAliases	array<object>	The hostnames and IP addresses for a container that are added to the hosts file of the elastic container instance.
HostAliase	object	The hostnames and IP addresses of a container that are added to the hosts file of the elastic container instance.
Hostnames	array	The information about the hosts.
Hostname	string	The hostname.	['hehe.com', 'haha.com']
Ip	string	The IP address of the instance.	192.0.XX.XX
Tags	array<object>	The tags that are added to the instance.
Label	object	The tags of the instances.
Key	string	The tag key.	name
Value	string	The tag value.	test-xh
Events	array<object>	The events of the elastic container instance. A maximum of 50 events can be returned.
Event	object	The events about the elastic container instances. A maximum of 50 events can be returned.
Type	string	The type of the event. Valid values: Normal Warning	Normal
LastTimestamp	string	The end time of the event.	2018-08-02T15:00:00Z
Message	string	The event message.	Started container
Name	string	The category to which the event belongs.	test-xxx
Reason	string	The event name.	Created
Count	integer	The number of the events.	20
FirstTimestamp	string	The start time of the event.	2018-08-02T15:00:00Z
SucceededTime	string	The time when all containers exited on success. The time follows the RFC 3339 standard. The time is displayed in UTC.	2019-12-11T04:33:42Z
SpotStrategy	string	The bid policy for the instance. Default value: NoSpot. Valid values: NoSpot: The instance is a regular pay-as-you-go instance. SpotWithPriceLimit: The instance is a preemptible instance that has a user-defined maximum hourly price. SpotAsPriceGo: The instance is a preemptible instance for which the market price at the time of purchase is automatically used as the bid price.	NoSpot
SpotPriceLimit	double	The maximum hourly price for the preemptible elastic container instance. This parameter is returned only when SpotStrategy is set to SpotWithPriceLimit.	0.025
EphemeralStorage	integer	The size of the temporary storage space. Unit: GiB.	20
TenantEniInstanceId	string	This parameter is not publicly available.	i-xxx
Discount	integer	The discount.	9
RestartPolicy	string	The restart policy of the elastic container instance. Valid values: Never: Never restarts the instance if a container in the instance exits upon termination. Always: Always restarts the instance if a container in the instance exits upon termination. OnFailure: Restarts the instance only if a container in the instance exists upon failure with a status code of non-zero.	Never
Memory	float	The memory size of the instance. Unit: GiB.	4.0
TenantVSwitchId	string	This parameter is not publicly available.	vsw-xxx
Containers	array<object>	The information about containers in the elastic container instance.
Container	object	The containers in the elastic container instance.
LivenessProbe	object	The liveness probe of the container.
SuccessThreshold	integer	The minimum number of consecutive successes that must occur for the check to be considered successful. Default value: 1. The value must be 1.	1
InitialDelaySeconds	integer	The number of seconds between the time when the startup of the container ends and the time when the probe starts.	10
FailureThreshold	integer	The minimum number of consecutive failures that must occur for the check to be considered failed. Default value: 3.	3
TimeoutSeconds	integer	The timeout period of the check. Default value: 1. Minimum value: 1. Unit: seconds.	10
TcpSocket	object	The TCP socket method that is used to check the container.
Host	string	The hostname.	1.2.3.4
Port	integer	The port number.	80
Execs	array	The commands that are used to check the containers.
Exec	string	The command that is used to check the container.	["/bin/sh", "-c", "echo Hello world > /usr/share/message"]
HttpGet	object	The HTTP GET method that is used to check the container.
Scheme	string	The protocol type supported by the method. Valid values: HTTP and HTTPS.	HTTP
Path	string	The path to which the system sends an HTTP GET request for a health check.	/usr/nginx/
Port	integer	The port to which the system sends an HTTP GET request for a health check.	80
PeriodSeconds	integer	The interval at which the health check is performed. Default value: 10. Minimum value: 1. Unit: seconds.	5
Commands	array	The startup commands of the container.
Command	string	The startup command of the container.	[/bin/sh echo]
VolumeMounts	array<object>	Information about the mounted volumes.
VolumeMount	object	Information about the mounted volumes.
MountPropagation	string	The mount propagation setting of the volume. Mount propagation allows volumes that are mounted on one 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 mount does not receive subsequent mounts that are performed on this volume or on the subdirectories of this volume. HostToCotainer: The volume mount receives subsequent mounts that are performed on this volume or on the subdirectories of this volume. Bidirectional: This value is similar to HostToCotainer. The volume mount receives subsequent mounts that are performed on this volume or on the subdirectories of this volume. In addition, all volume mounts that are performed on the container are propagated back to the host and all containers of all pods that use the same volume.	None
MountPath	string	The directory of the volume that is mounted to the container. The data in this directory is overwritten by the data on the volume.	/usr/share/
ReadOnly	boolean	Indicates whether the volume is read-only.	false
Name	string	The volume name.	test-empty
SubPath	string	The subdirectory of the volume. You can use this parameter to mount the same volume to different subdirectories of the container.	/usr/sub
Args	array	The arguments that are passed to the startup commands of the container.
Arg	string	The argument that is passed to the startup command of the container.	["hello"]
Image	string	The image in the container.	mysql
Ports	array<object>	The exposed port and protocol of the container.
Port	object	The exposed port and protocol of the container.
Protocol	string	The protocol type.	TCP
Port	integer	The port number. Valid values: 1 to 65535.	8080
RestartCount	integer	The number of times that the container restarted.	0
ImagePullPolicy	string	The image pulling policy. Valid values: Always: Each time the instance is updated, image pulling is performed. IfNotPresent: On-premises images are preferentially used. If no on-premises images are available, image pulling is performed. Never: On-premises images are always used. Image pulling is not performed.	Always
StdinOnce	boolean	Indicates whether standard input streams are disconnected after a client is disconnected. If Stdin is set to true, standard input streams remain connected among multiple sessions. If StdinOnce is set to true, standard input streams are connected after the container is started, and remain idle until a client is connected to receive data. After the client is disconnected, streams are also disconnected, and remain disconnected until the container restarts.	true
Cpu	float	The number of vCPUs that are allocated to the container.	2.0
PreviousState	object	The previous state of the container.
StartTime	string	The time when the container started to run.	2018-08-02T15:00:00Z
FinishTime	string	The time when the container stopped running.	2018-08-02T15:00:00Z
DetailStatus	string	The details of the container status.	working
State	string	The container status. Valid values: Waiting: The container is being started. Running: The container is running. Terminated: The container stops running.	Terminated
Message	string	The message about the container status.	Back-off 5m0s restarting failed container=test pod=test_eci-xxx(xxx)
Signal	integer	The code of the container status.	1
ExitCode	integer	The exit code of the container.	0
Reason	string	The reason why the container is in this status.	Completed
Tty	boolean	Indicates whether interaction is enabled. Default value: false. If the value of the Command parameter is `/bin/bash`, the value of this parameter is true.	false
WorkingDir	string	The working directory of the container.	/usr/local/nginx
CurrentState	object	The current container status.
StartTime	string	The time when the container started to run.	2019-12-19T12:05:02Z
FinishTime	string	The time when the container stopped running.	2018-08-02T15:00:00Z
DetailStatus	string	The details of the container status.	working
State	string	The container status. Valid values: Waiting Running Terminated	Terminated
Message	string	The message about the container status.	Back-off 5m0s restarting failed container=test pod=test_eci-xxx(xxx)
Signal	integer	The code of the container status.	1
ExitCode	integer	The exit code of the container.	0
Reason	string	The reason why the container is in this status.	Started
Ready	boolean	Indicates whether the container passed the readiness probe.	true
Gpu	integer	The number of GPUs.	1
SecurityContext	object	The security context of the elastic container instance.
ReadOnlyRootFilesystem	boolean	Indicates whether permissions on the root file system are read-only. Valid value: true.	true
RunAsUser	long	The user ID (UID) that is used to run the container.	1000
Capability	object	The permissions specific to the processes in the container.
Adds	array	The permissions specific to the process in the container.
Add	string	The permission specific to the process in the container.	[NET_ADMIN]
Memory	float	The memory size of the container. Unit: GiB.	2.0
Stdin	boolean	Indicates whether the container allocates buffer resources to standard input streams when the container is running. If you do not specify this parameter, an end-of-file (EOF) error may occur when standard input streams in the container are read. Default value: false.	true
Name	string	The name of the container.	nginx
EnvironmentVars	array<object>	The environment variables of the container.
EnvironmentVar	object	The environment variables of the container.
Key	string	The name of the environment variable.	PATH
Value	string	The value of the environment variable.	/usr/bin/
ValueFrom	object	The source of the environment variable value. This parameter has a value only when the Value parameter is left empty.
FieldRef	object	The specified field.
FieldPath	string	The path of the field.	status.podIP
ReadinessProbe	object	The readiness probe that is used to check whether the container is ready to serve a request.
SuccessThreshold	integer	The minimum number of consecutive successes that must occur for the check to be considered successful. Default value: 1. The value must be 1.	1
InitialDelaySeconds	integer	The number of seconds between the time when the startup of the container ends and the time when the probe starts.	5
FailureThreshold	integer	The minimum number of consecutive failures that must occur for the check to be considered failed. Default value: 3.	3
TimeoutSeconds	integer	The timeout period of the check. Default value: 1. Minimum value: 1. Unit: seconds.	1
TcpSocket	object	The TCP socket method that is used to check the container.
Host	string	The hostname.	1.2.3.4
Port	integer	The port number.	8888
Execs	array	The commands that are run in the container when you use a CLI to perform health checks.
Exec	string	The command that is run in the container when you use a CLI to perform health checks.	["/bin/sh", "-c", "echo Hello world > /usr/share/message"]
HttpGet	object	The HTTP GET method that is used to check the container.
Scheme	string	The protocol type supported by the method. Valid values: HTTP and HTTPS.	HTTP
Path	string	The path to which the system sends an HTTP GET request for a health check.	/usr/local
Port	integer	The port to which the system sends an HTTP GET request for a health check.	8080
PeriodSeconds	integer	The interval at which the health check is performed. Default value: 10. Minimum value: 1. Unit: seconds.	1
EniInstanceId	string	The ID of the elastic network interface (ENI).	eni-bp14rzqi6fd8satm****
InitContainers	array<object>	The information about the init containers.
Container	object	The init containers.
VolumeMounts	array<object>	The information about the volumes that are mounted to the init container.
VolumeMount	object	The information about the volumes that are mounted to the init container.
MountPropagation	string	The mount propagation setting of the volume. Mount propagation allows volumes that are mounted on one 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 mount does not receive subsequent mounts that are performed on this volume or on the subdirectories of this volume. HostToCotainer: The volume mount receives subsequent mounts that are performed on this volume or on the subdirectories of this volume. Bidirectional: This value is similar to HostToCotainer. The volume mount receives subsequent mounts that are performed on this volume or on the subdirectories of this volume. In addition, all volume mounts that are performed on the container are propagated back to the host and all containers of all pods that use the same volume.	None
MountPath	string	The directory of the volume that is mounted to the container. The data in this directory is overwritten by the data on the volume.	/usr/share/
ReadOnly	boolean	Indicates whether the volume is read-only.	false
Name	string	The name of the volume. The value of this parameter is the same as the name of the volume that you selected when you purchased the container.	test-empty
Args	array	The arguments that are passed to the startup commands of the container.
Arg	string	The argument that is passed to the startup command of the container.	['hello world']
Image	string	The image of the container.	nginx
Ports	array<object>	The exposed port and protocol of the container.
Port	object	The exposed ports and protocols of the container.
Protocol	string	The protocol type.	TCP
Port	integer	The port number. Valid values: 1 to 65535.	8888
RestartCount	integer	The number of times that the container restarted.	5
ImagePullPolicy	string	The image pulling policy. Valid values: Always: Each time the instance is updated, image pulling is performed. IfNotPresent: On-premises images are preferentially used. If no on-premises images are available, image pulling is performed. Never: On-premises images are always used. Image pulling is not performed.	Always
PreviousState	object	The previous state of the container.
StartTime	string	The time when the container started to run.	2019-12-24T05:35:44Z
FinishTime	string	The time when the container stopped running.	2019-12-24T05:35:44Z
DetailStatus	string	The details of the container status.	working
State	string	The container status. Valid values: Waiting, Running, and Terminated.	Terminated
Message	string	The message about the container status.	Started container
Signal	integer	The code of the container status.	1
ExitCode	integer	The exit code of the container.	0
Reason	string	The reason why the container is in this status.	completed
WorkingDir	string	The working directory of the container.	/usr/test
Cpu	float	The number of vCPUs that are allocated to the container.	1.0
CurrentState	object	The current container status.
StartTime	string	The time when the container started to run.	2018-08-02T15:00:00Z
FinishTime	string	The time when the container stopped running.	2018-08-02T15:00:00Z
DetailStatus	string	The details of the container status.	working
State	string	The container status. Valid values: Waiting Running Terminated	Running
Message	string	The event message.	Created container
Signal	integer	The code of the container status.	1
ExitCode	integer	The exit code of the container.	0
Reason	string	The reason why the container is in this status.	Started
Command	array	The startup commands of the containers.
Command	string	The startup command of the container.	[/bin/sh echo]
Ready	boolean	Indicates whether the container passed the readiness probe.	true
Gpu	integer	The number of GPUs.	1
SecurityContext	object	The security context of the container.
ReadOnlyRootFilesystem	boolean	Indicates whether permissions on the root file system are read-only.	true
RunAsUser	long	The UID that is used to run the entry point of the container process.	1557
Capability	object	The permissions specific to the processes in the container.
Adds	array	The permissions specific to the processes in the container.
Add	string	The permission specific to the process in the container.	NET_ADMIN
Memory	float	The memory size of the init container. Unit: GiB.	2.0
Name	string	The name of the init container.	Init-xxx
EnvironmentVars	array<object>	The environment variables of the init container.
EnvironmentVar	object	The environment variables of the container.
Key	string	The name of the environment variable.	PATH
Value	string	The value of the environment variable.	/usr/local/bin
ValueFrom	object	The source of the environment variable value. This parameter has a value only when the Value parameter is left empty.
FieldRef	object	The specified fields.
FieldPath	string	The path of the field. Only `status.podIP` is supported.	status.podIP
ContainerGroupId	string	The instance ID.	eci-bp1jrgfqqy54kg5hc****
TenantEniIp	string	This parameter is not publicly available.	10.10.XX.XX
InstanceType	string	The instance type of the specified Elastic Compute Service (ECS) instance.	ecs.g5.large
IntranetIp	string	The private IP address.	172.16.XX.XX
Ipv6Address	string	The IPv6 address of the instance.	2001:XXXX:4:4:4:4:4:4
RegionId	string	The region ID of the instance.	cn-hangzhou
DnsConfig	object	The Domain Name System (DNS) settings.
Searches	array	The search domains of DNS servers.
Search	string	The search domain of the DNS server.	svc.local.kubenetes
Options	array<object>	The options. Each option is a name-value pair. The value in the name-value pair is optional.
Option	object	The options. Each option is a name-value pair. The value in the name-value pair is optional.
Value	string	The variable value of the option.	value
Name	string	The variable name of the option.	name
NameServers	array	The IP addresses of DNS servers.
NameServer	string	The IP address of the DNS server.	[10.2..]
Volumes	array<object>	The information about the volumes.
Volume	object	Information about the volume.
Type	string	The type of the volume. Valid values: EmptyDirVolume NFSVolume ConfigFileVolume FlexVolume	EmptyDirVolume
DiskVolumeDiskId	string	The ID of the disk when you set Type to DiskVolume.	d-xxxx
NFSVolumeReadOnly	boolean	Indicates whether the NFS volume is read-only.	false
ConfigFileVolumeConfigFileToPaths	array<object>	The path of the ConfigFile volume.
ConfigFileVolumeConfigFileToPath	object	The path of the ConfigFile volume.
Path	string	The relative path of the ConfigFile volume.	/usr/bin/
Content	string	The content of the ConfigFile volume. Maximum size: 32 KB.	hello world
FlexVolumeFsType	string	The file system type when you set the Type parameter to FlexVolume. The default value varies based on the script of the FlexVolume plug-in.	ntfs
FlexVolumeDriver	string	The name of the driver when you set the Type parameter to FlexVolume.	flexvolume
DiskVolumeFsType	string	The file system type of the disk volume.	xfs
FlexVolumeOptions	string	The options when you set the Type parameter to FlexVolume.	[nolock,tcp,noresvport]
NFSVolumeServer	string	The address of the NFS server.	0eafxxxxx-xxxxx.cn-hangzhou.nas.aliyuncs.com
NFSVolumePath	string	The path of the NFS volume.	/eci
Name	string	The volume name.	test-empty
EmptyDirVolumeMedium	string	The storage media for the emptyDir volume. This parameter is empty by default, indicating that the node file system is used as the storage media. Valid values: Memory: Memory is used as the storage media. LocalRaid0: Local disks are formed into RAID 0. This value is valid only if an elastic container instance that has local disks mounted is created. For more information, see Create an elastic container instance that has local disks mounted.	Memory
EmptyDirVolumeSizeLimit	string	The storage size of the emptyDir volume.	256Mi
RamRoleName	string	The name of the instance RAM role. The elastic container instance and the ECS instance share a RAM role. For more information, see Use an instance RAM role by calling API operations.	ram:PassRole
VSwitchId	string	The ID of the vSwitch to which the instance is connected.	vsw-bp1vzjjflab6wvjox****
Cpu	float	The number of vCPUs that are allocated to the elastic container instance.	2.0
ExpiredTime	string	The time when the elastic container instance failed to run due to overdue payments. The time follows the RFC 3339 standard. The time is displayed in UTC.	2018-08-02T15:00:00Z
ResourceGroupId	string	The resource group ID.	rg-8db03793gfrz****
ZoneId	string	The zone to which the instance belongs.	cn-hangzhou-h
ContainerGroupName	string	The instance name.	test
EciSecurityContext	object	The security context of the elastic container instance.
Sysctls	array<object>	sysctl parameters.
Sysctl	object	Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported sysctls (by the container runtime) might fail to launch.
Value	string	The value of the Sysctl parameter.	65536
Name	string	The name of the Sysctl parameter.	kernel.msgmax
FailedTime	string	The time when the instance failed to run. The time follows the RFC 3339 standard. The time is displayed in UTC.	2018-08-02T15:00:00Z
ComputeCategory	string	The computing power type of the elastic container instance. Valid values: economy: economic computing power. general: general-purpose computing power.	economy

Examples

Sample success responses

JSONformat

{
  "TotalCount": 1,
  "NextToken": "d78f2dd8-5979-42fe-****-b16db43be5bc",
  "RequestId": "89945DD3-9072-47D0-A318-353284CFC7B3",
  "ContainerGroups": [
    {
      "Status": "Running",
      "CreationTime": "2018-08-02T15:00:00Z",
      "VpcId": "vpc-1vzjjflab6wvjox****",
      "InternetIp": "192.0.XX.XX",
      "TenantSecurityGroupId": "sg-xxx",
      "SecurityGroupId": "sg-bp12ujq5zpxuyjfo3o8r",
      "HostAliases": [
        {
          "Hostnames": [
            "['hehe.com', 'haha.com']"
          ],
          "Ip": "192.0.XX.XX"
        }
      ],
      "Tags": [
        {
          "Key": "name",
          "Value": "test-xh"
        }
      ],
      "Events": [
        {
          "Type": "Normal",
          "LastTimestamp": "2018-08-02T15:00:00Z",
          "Message": "Started container",
          "Name": "test-xxx",
          "Reason": "Created",
          "Count": 20,
          "FirstTimestamp": "2018-08-02T15:00:00Z"
        }
      ],
      "SucceededTime": "2019-12-11T04:33:42Z",
      "SpotStrategy": "NoSpot",
      "SpotPriceLimit": 0.025,
      "EphemeralStorage": 20,
      "TenantEniInstanceId": "i-xxx",
      "Discount": 9,
      "RestartPolicy": "Never",
      "Memory": 4,
      "TenantVSwitchId": "vsw-xxx",
      "Containers": [
        {
          "LivenessProbe": {
            "SuccessThreshold": 1,
            "InitialDelaySeconds": 10,
            "FailureThreshold": 3,
            "TimeoutSeconds": 10,
            "TcpSocket": {
              "Host": "1.2.3.4",
              "Port": 80
            },
            "Execs": [
              "[\"/bin/sh\", \"-c\", \"echo Hello world > /usr/share/message\"]"
            ],
            "HttpGet": {
              "Scheme": "HTTP",
              "Path": "/usr/nginx/",
              "Port": 80
            },
            "PeriodSeconds": 5
          },
          "Commands": [
            "[/bin/sh echo]"
          ],
          "VolumeMounts": [
            {
              "MountPropagation": "None",
              "MountPath": "/usr/share/",
              "ReadOnly": false,
              "Name": "test-empty",
              "SubPath": "/usr/sub"
            }
          ],
          "Args": [
            "[\"hello\"]"
          ],
          "Image": "mysql",
          "Ports": [
            {
              "Protocol": "TCP",
              "Port": 8080
            }
          ],
          "RestartCount": 0,
          "ImagePullPolicy": "Always",
          "StdinOnce": true,
          "Cpu": 2,
          "PreviousState": {
            "StartTime": "2018-08-02T15:00:00Z\t",
            "FinishTime": "2018-08-02T15:00:00Z\t",
            "DetailStatus": "working",
            "State": "Terminated",
            "Message": "Back-off 5m0s restarting failed container=test pod=test_eci-xxx(xxx)",
            "Signal": 1,
            "ExitCode": 0,
            "Reason": "Completed"
          },
          "Tty": false,
          "WorkingDir": "/usr/local/nginx",
          "CurrentState": {
            "StartTime": "2019-12-19T12:05:02Z",
            "FinishTime": "2018-08-02T15:00:00Z\t",
            "DetailStatus": "working",
            "State": "Terminated",
            "Message": "Back-off 5m0s restarting failed container=test pod=test_eci-xxx(xxx)",
            "Signal": 1,
            "ExitCode": 0,
            "Reason": "Started"
          },
          "Ready": true,
          "Gpu": 1,
          "SecurityContext": {
            "ReadOnlyRootFilesystem": true,
            "RunAsUser": 1000,
            "Capability": {
              "Adds": [
                "[NET_ADMIN]"
              ]
            }
          },
          "Memory": 2,
          "Stdin": true,
          "Name": "nginx",
          "EnvironmentVars": [
            {
              "Key": "PATH",
              "Value": "/usr/bin/",
              "ValueFrom": {
                "FieldRef": {
                  "FieldPath": "status.podIP"
                }
              }
            }
          ],
          "ReadinessProbe": {
            "SuccessThreshold": 1,
            "InitialDelaySeconds": 5,
            "FailureThreshold": 3,
            "TimeoutSeconds": 1,
            "TcpSocket": {
              "Host": "1.2.3.4",
              "Port": 8888
            },
            "Execs": [
              "[\"/bin/sh\", \"-c\", \"echo Hello world > /usr/share/message\"]"
            ],
            "HttpGet": {
              "Scheme": "HTTP",
              "Path": "/usr/local",
              "Port": 8080
            },
            "PeriodSeconds": 1
          }
        }
      ],
      "EniInstanceId": "eni-bp14rzqi6fd8satm****",
      "InitContainers": [
        {
          "VolumeMounts": [
            {
              "MountPropagation": "None",
              "MountPath": "/usr/share/",
              "ReadOnly": false,
              "Name": "test-empty"
            }
          ],
          "Args": [
            "['hello world']"
          ],
          "Image": "nginx",
          "Ports": [
            {
              "Protocol": "TCP",
              "Port": 8888
            }
          ],
          "RestartCount": 5,
          "ImagePullPolicy": "Always",
          "PreviousState": {
            "StartTime": "2019-12-24T05:35:44Z",
            "FinishTime": "2019-12-24T05:35:44Z",
            "DetailStatus": "working",
            "State": "Terminated",
            "Message": "Started container",
            "Signal": 1,
            "ExitCode": 0,
            "Reason": "completed"
          },
          "WorkingDir": "/usr/test",
          "Cpu": 1,
          "CurrentState": {
            "StartTime": "2018-08-02T15:00:00Z\t",
            "FinishTime": "2018-08-02T15:00:00Z\t",
            "DetailStatus": "working",
            "State": "Running",
            "Message": "Created container",
            "Signal": 1,
            "ExitCode": 0,
            "Reason": "Started"
          },
          "Command": [
            "[/bin/sh echo]"
          ],
          "Ready": true,
          "Gpu": 1,
          "SecurityContext": {
            "ReadOnlyRootFilesystem": true,
            "RunAsUser": 1557,
            "Capability": {
              "Adds": [
                "NET_ADMIN"
              ]
            }
          },
          "Memory": 2,
          "Name": "Init-xxx",
          "EnvironmentVars": [
            {
              "Key": "PATH",
              "Value": "/usr/local/bin",
              "ValueFrom": {
                "FieldRef": {
                  "FieldPath": "status.podIP"
                }
              }
            }
          ]
        }
      ],
      "ContainerGroupId": "eci-bp1jrgfqqy54kg5hc****",
      "TenantEniIp": "10.10.XX.XX",
      "InstanceType": "ecs.g5.large",
      "IntranetIp": "172.16.XX.XX",
      "Ipv6Address": "2001:XXXX:4:4:4:4:4:4",
      "RegionId": "cn-hangzhou",
      "DnsConfig": {
        "Searches": [
          "svc.local.kubenetes"
        ],
        "Options": [
          {
            "Value": "value",
            "Name": "name"
          }
        ],
        "NameServers": [
          "[10.2.*.*]"
        ]
      },
      "Volumes": [
        {
          "Type": "EmptyDirVolume",
          "DiskVolumeDiskId": "d-xxxx",
          "NFSVolumeReadOnly": false,
          "ConfigFileVolumeConfigFileToPaths": [
            {
              "Path": "/usr/bin/",
              "Content": "hello world"
            }
          ],
          "FlexVolumeFsType": "ntfs",
          "FlexVolumeDriver": "flexvolume",
          "DiskVolumeFsType": "xfs",
          "FlexVolumeOptions": "[nolock,tcp,noresvport]",
          "NFSVolumeServer": "0eafxxxxx-xxxxx.cn-hangzhou.nas.aliyuncs.com",
          "NFSVolumePath": "/eci",
          "Name": "test-empty",
          "EmptyDirVolumeMedium": "Memory",
          "EmptyDirVolumeSizeLimit": "256Mi"
        }
      ],
      "RamRoleName": "ram:PassRole",
      "VSwitchId": "vsw-bp1vzjjflab6wvjox****",
      "Cpu": 2,
      "ExpiredTime": "2018-08-02T15:00:00Z",
      "ResourceGroupId": "rg-8db03793gfrz****",
      "ZoneId": "cn-hangzhou-h",
      "ContainerGroupName": "test",
      "EciSecurityContext": {
        "Sysctls": [
          {
            "Value": "65536",
            "Name": "kernel.msgmax"
          }
        ]
      },
      "FailedTime": "2018-08-02T15:00:00Z",
      "ComputeCategory": "economy",
      "DnsPolicy": ""
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParameter.MismatchInstanceType	The instanceId mismatch instance type.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-09-26	The Error code has changed. The response structure of the API has changed	View Change Details
2024-09-04	The Error code has changed	View Change Details
2023-12-27	The request parameters of the API has changed	View Change Details
2023-12-25	The request parameters of the API has changed. The response structure of the API has changed	View Change Details
2023-04-17	The response structure of the API has changed	View Change Details
2023-04-04	The response structure of the API has changed	View Change Details