This topic describes the response parameters in Elastic Container Instance (ECI) API responses.
| Parameter | Description |
|---|---|
| ContainerGroup | The container group. |
| ImageRegistryCredential | The information for logging on to the image repository. |
| Volume | The volume. |
| Event | The event. |
| Tag | The tag of the container. |
| DNSConfig | The Domain Name System (DNS) settings. |
| Container | The container. |
| ContainerState | The status of the container. |
| VolumeMount | The mount point of the volume. |
| EnvironmentVar | The environment variable. |
| ContainerPort | The port of the container. |
| SecurityContext | The security context of the container group. |
| ReadinessProbe | The readiness probe of the container. |
| LivenessProbe | The liveness probe of the container. |
ContainerGroup
| Parameter | Type | Description |
|---|---|---|
| RegionId | String | The region ID of the container group. |
| ZoneId | String | The ID of the zone where the container group is deployed. If you do not set a zone ID for a container group, the system assigns a zone ID for the container group. The default value is the zone ID assigned by the system. |
| SecurityGroupId | String | The ID of the security group to which the container group belongs. Container groups from the same security group can access each other. |
| VSwitchId | String | The ID of the VSwitch. Currently, container groups can only be deployed in Virtual Private Clouds (VPCs). |
| ContainerGroupName | String | The name of the container group. |
| ContainerGroupId | String | The ID of the container group. |
| ImageRegistryCredentials | ImageRegistryCredential[] | The information for logging on to image repositories. A maximum of 10 sets of image repository logon information can be returned. |
| Volumes | Volume[] | The volumes mounted to the container group. A maximum of 20 volumes can be returned. |
| RestartPolicy | String | The restart policy of the container group. Valid values: Always, OnFailure, and Never. |
| Cpu | Float | The amount of CPU resources allocated to the container group. Unit: vCPUs. |
| Memory | Float | The amount of memory resources allocated to the container group. Unit: GiB. |
| InitContainers | Container[] | The init containers. A maximum of five init containers can be returned. |
| Containers | Container[] | The containers. A maximum of five containers can be returned. |
| Events | Event[] | The events of the container group. A maximum of 50 events can be returned. |
| DNSConfig | DNSConfig | The DNS settings. |
| InternetIp | String | The public IP address of the container group. |
| IntranetIP | String | The internal IP address of the container group. |
| Tags | Tag[] | The tags attached to the container group. Each tag is a key-value pair. A maximum of 20 tags can be returned. |
| Status | String | The creation status of the container group. Valid values: Pending, Running, Succeeded, Failed, Scheduling, and ScheduleFailed. |
| CreationTime | String | The time when the system created the container group after receiving the request. The time follows the RFC 3339 standard and is displayed in UTC, for example, 2018-08-02T15:00:00Z. |
| SucceededTime | String | The time when all containers in the container group completed running the specified tasks. The time follows the RFC 3339 standard and is displayed in UTC, for example, 2018-08-02T15:00:00Z. |
| EniInstanceId | String | The ID of the Elastic Network Interface (ENI) instance. |
| ExpiredTime | String | The time when the container failed to run due to overdue payments. The time follows the RFC 3339 standard and is displayed in UTC, for example, 2018-08-02T15:00:00Z. |
| FailedTime | String | The time when the container failed to run tasks. The time follows the RFC 3339 standard and is displayed in UTC, for example, 2018-08-02T15:00:00Z. |
ImageRegistryCredential
| Parameter | Type | Required | Description |
|---|---|---|---|
| Server | String | Yes | The address of the image repository, without the http:// or https:// prefix. |
| UserName | String | Yes | The username used to log on to the image repository. |
| Password | String | Yes | The password used to log on to the image repository. |
Volume
| Parameter | Type | Required | Description |
|---|---|---|---|
| Type | String | Yes | The type of the volume. Valid values: EmptyDirVolume, NFSVolume, and ConfigFileVolume. |
| Name | String | Yes | The name of the volume. |
| NFSVolume.Server | String | No | The address of the Network File System (NFS) server. |
| NFSVolume.Path | String | No | The path to the nfs volume. |
| NFSVolume.ReadOnly | Boolean | No | Indicates whether the nfs volume is set to the read-only mode. Default value: false. |
| ConfigFileVolume.ConfigFileToPath | ConfigFileToPath[] | No | The paths to configuration files. |
| EmptyDirVolume.Medium | String | No | The storage medium of the emptyDir volume. If you do not specify a storage medium for the emptyDir volume, it stores data in the file system of a node by default. A value of Memory indicates that the emptyDir volume stores data in the memory. |
ConfigFileToPath
| Parameter | Type | Required | Description |
|---|---|---|---|
| Path | String | Yes | The relative path to the configuration file. |
| Content | String | No | The content of the configuration file. The maximum size of the file can be 32 KB. |
Event
| Parameter | Type | Description |
|---|---|---|
| Count | Integer | The number of events. |
| FirstTimestamp | String | The time when the event started. |
| LastTimestamp | String | The time when the event ended. |
| Message | String | The content of the event. |
| Name | String | The name of the object to which the event belongs. |
| Type | String | The type of the event. Valid values: Normal and Warning. |
| Reason | String | The name of the event. |
Tag
| Parameter | Type | Required | Description |
|---|---|---|---|
| Key | String | Yes | The key of the tag. |
| Value | String | No | The value of the tag. |
DNSConfig
https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-s-dns-config
| Parameter | Type | Description |
|---|---|---|
| Nameservers | String[] | The IP addresses of DNS servers. |
| Searches | String[] | The DNS search domains. |
| Options | Option[] | The objects. Each object is a name-value pair. The value is optional. |
Option
| Parameter | Type | Description |
|---|---|---|
| Name | String | The name of the object. |
| Value | String | The value of the object. |
Container
| Parameter | Type | Required | Description |
|---|---|---|---|
| Commands | String[] | No | The commands used to start the container. A maximum of 20 commands can be specified to start a container. Each command is a string and can be up to 256 characters in length. |
| Args | String[] | No | The startup parameters of the container. A maximum of 10 startup parameters can be specified to start a container. |
| EnvironmentVars | EnvironmentVar[] | No | The environment variables in the operating system in which you run the container. Each environment variable is a key-value pair. Both the key and value are strings. A maximum of 100 environment variables can be returned. Key indicates the name of a variable and Value indicates the value of the variable. |
| Image | String | Yes | The image of the container. |
| Name | String | Yes | The name of the container. |
| Cpu | Float | Yes | The amount of CPU resources allocated to the container. Unit: vCPUs. |
| Memory | Float | Yes | The amount of memory resources allocated to the container. Unit: GiB. |
| ImagePullPolicy | String | No | The policy for pulling an image. |
| VolumeMounts | VolumeMount[] | No | The volumes mounted to the container. A maximum of 16 volumes can be returned. |
| CurrentState | ContainerState | No | The current status of the container. |
| PreviousState | ContainerState | No | The previous status of the container. |
| RestartCount | Integer | No | The number of times that the container has restarted. |
| WorkingDir | String | No | The working directory of the container. |
| Ports | Port[] | No | The exposed ports and protocols of the container. A maximum of 100 port and protocol combinations can be returned. |
| LivenessProbe | LivenessProbe | No | The liveness probe of the container. |
| ReadinessProbe | ReadinessProbe | No | The readiness probe of the container. |
| SecurityContext | SecurityContext | No | The security context of the container group. For more information, see Configure a Security Context for a Pod or Container. |
ContainerState
| Parameter | Type | Description |
|---|---|---|
| StartTime | Timestamp | The time when the container started to run. |
| State | String | The status of the container. Valid values: Waiting, Running, and Terminated. |
| DetailStatus | String | The details of the container status. |
| FinishTime | Timestamp | The time when the container stopped running. |
| ExitCode | Integer | The exit code of the container. |
| Reason | String | The reason why the container is in this status. |
| Message | String | The information about the container status. |
| Signal | Integer | The code of the container status. |
VolumeMount
| Parameter | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | The name of the volume. The name is the same as the volume you selected when you purchased the container group. |
| MountPath | String | Yes | The directory to which the volume is mounted. Data under this directory is overwritten by the data on the volume. |
| ReadOnly | Boolean | Yes | Indicates whether the volume is set to the read-only mode. Default value: false. |
EnvironmentVar
| Parameter | Type | Required | Description |
|---|---|---|---|
| Key | String | Yes | The name of the variable. The name can be 1 to 128 characters in length and can contain letters, digits, and underscores (_). It cannot start with a digit. |
| Value | String | No | The value of the variable. The value can be 0 to 256 characters in length. |
| FieldRef.FieldPath | String | No | The source of the variable value. Currently, the only valid value is status.podIP. |
Port
| Parameter | Type | Description |
|---|---|---|
| Port | Integer | The port number of the container. Valid values: 1 to 65535. |
| Protocol | String | The protocol of the container. Valid values: TCP and UDP. |
SecurityContext
| Parameter | Type | Description |
|---|---|---|
| Capability | Capability | The default capabilities of the container. Currently, only the CPU and memory are supported. |
| RunAsUser | Integer | N/A |
| ReadOnlyRootFilesystem | Boolean | Indicates whether the root file system is set to the read-only mode. Currently, the only valid value is true. |
Capability
| Parameter | Type | Description |
|---|---|---|
| Adds | String[] | The capability that you can add. Currently, the only valid value is NET_ADMIN. |
ReadinessProbe
| Parameter | Type | Description |
|---|---|---|
| ReadinessProbe.HttpGet.Path | String | The path to the HTTP GET method. |
| ReadinessProbe.HttpGet.Port | Integer | The port for the HTTP GET method. |
| ReadinessProbe.HttpGet.Scheme | String | The scheme used for connecting to the host. Valid values: HTTP and HTTPS. |
| ReadinessProbe.Exec.Commands | String[] | The commands used to check the container. |
| ReadinessProbe.TcpSocket.Port | Integer | The port for the TCP socket method. |
| N/A | N/A | Note: The method used to check the container can be Exec, HttpGet, or TcpSocket. |
| ReadinessProbe.InitialDelaySeconds | Integer | The time when the check started. The initial time is when the container is started. |
| ReadinessProbe.PeriodSeconds | Integer | The interval for checking the container. Default value: 10. Minimum value: 1. Unit: seconds. |
| ReadinessProbe.SuccessThreshold | Integer | After the last check failed, the minimum number of consecutive times that a check must be successful before the check is declared successful. Default value: 1. |
| ReadinessProbe.FailureThreshold | Integer | After the last check succeeded, the minimum number of consecutive times that a check must fail before the check is declared failed. Default value: 3. |
| ReadinessProbe.TimeoutSeconds | Integer | The timeout period of the check. Default value: 1. Minimum value: 1. Unit: seconds. |
LivenessProbe
| Parameter | Type | Description |
|---|---|---|
| LivenessProbe.HttpGet.Path | String | The path to the HTTP GET method. |
| LivenessProbe.HttpGet.Port | Integer | The port for the HTTP GET method. |
| LivenessProbe.HttpGet.Scheme | String | The scheme used for connecting to the host. Valid values: HTTP and HTTPS. |
| LivenessProbe.Exec.Commands | String[] | The commands used to check the container. |
| LivenessProbe.TcpSocket.Port | Integer | The port for the TCP socket method. |
| LivenessProbe.InitialDelaySeconds | Integer | The time when the check started. The initial time is when the container is started. |
| LivenessProbe.PeriodSeconds | Integer | The interval for checking the container. Default value: 10. Minimum value: 1. Unit: seconds. |
| LivenessProbe.SuccessThreshold | Integer | After the last check failed, the minimum number of consecutive times that a check must be successful before the check is declared successful. Default value: 1. Currently, this value must be 1. |
| LivenessProbe.FailureThreshold | Integer | After the last check succeeded, the minimum number of consecutive times that a check must fail before the check is declared failed. Default value: 3. |
| LivenessProbe.TimeoutSeconds | Integer | The timeout period of the check. Default value: 1. Minimum value: 1. Unit: seconds. |