All Products
Search
Document Center

Data Type

Last Updated: Aug 15, 2019

Data types

Data type Description
ContainerGroup A container group.
ImageRegistryCredential The information that you need to log on to the container image repository, including the server address, username, and password.
Volume A volume.
Event The information about an event of the container group.
Tag A tag for the container.
DNSConfig A DNS configuration.
Container A container in the container group.
ContainerState The status of the container.
VolumeMount A volume mount point.
EnvironmentVar Environment variables of the container.
ContainerPort A container port.
SecurityContext The security context of the container group.
ReadinessProbe The readiness probe.
LivenessProbe The liveness probe.

ContainerGroup

Member Type Description
RegionId String The ID of the region in which the container group resides.
ZoneId String The ID of the zone in which the container group resides. If you do not specify this parameter, the system assigns a zone ID for the container group.
SecurityGroupId String The ID of the security group to which the container group belongs. Container groups in the same security group can access each other.
VSwitchId String The ID of the specified VSwitch to connect to. Currently, container groups can only be deployed in VPC networks.
ContainerGroupName String The name of the container group.
ContainerGroupId String The ID of the container group.
ImageRegistryCredentials ImageRegistryCredential[] The information for logging on to the container image repository. You can specify a maximum of 10 image repositories for each account.
Volumes Volume[] The data volume. You can specify a maximum of 20 data volumes.
RestartPolicy String The policy for restarting the container. Valid values: Always, OnFailure, and Never.
Cpu Float The maximum vCPUs for the container group. Unit: vCPUs (cores).
Memory Float The maximum memory for the container group. Unit: GiB.
InitContainers Container[] The list of initialization containers. You can set a maximum of five containers in a container group.
Containers Container[] The list of containers. You can specify a maximum of five containers in a container group.
Events Event[] The information about events. A maximum of 50 events are supported.
DNSConfig DNSConfig The information about DNS configurations.
InternetIp String The public IP address.
IntranetIP String The internal IP address.
Tags Tag[] The list of container group tags in the form of key/value pairs. You can define a maximum of 20 tags for each container group.
Status String The status of the container group. Valid values: Pending, Running, Succeeded, Failed, Scheduling, and ScheduleFailed.
CreationTime String The time at which the system receives the request for creating the container group. The time follows the RFC 3339 standard in UTC. For example, 2018-08-02T15:00:00Z format.
SucceededTime String The time when all containers in the same container group exit after executing specified tasks. The time follows the RFC 3339 standard in UTC. For example, 2018-08-02T15:00:00Z format.
EniInstanceId String The ID of the elastic network interface (ENI).
ExpiredTime String The time when a container group failed because you have overdue payments. The time follows the RFC 3339 standard in UTC. For example, 2018-08-02T15:00:00Z format.
FailedTime String The time when the container failed to run. The time follows the RFC 3339 standard in UTC. For example, 2018-08-02T15:00:00Z format.

ImageRegistryCredential

Parameter Member Required Description
Server String Yes The IP address of the image repository. This address does not include a protocol prefix, such as http:// or https://.
UserName String Yes The username that is used to log on to the image repository.
Password String Yes The password that is used to log on to the image repository.

Volume

Member Type Required Description
Type String Yes The type of volume. Valid values: EmptyDirVolume, NFSVolume, and ConfigFileVolume.
Name String Yes The name of the volume.
NFSVolume.Server String No The IP address of the NFS server.
NFSVolume.Path String No The path to the NFS volume.
NFSVolume.ReadOnly Boolean No Default value: False.
ConfigFileVolume.ConfigFileToPath ConfigFileToPath[] No The path to the configuration file.
EmptyDirVolume.Medium String No The storage medium for EmptyDirVolume. By default, the file system on the node is used. Default value: not specified. Valid value: Memory. If this parameter is set to Memory, the EmptyDirVolume volume is stored in memory.

ConfigFileToPath

Member Type Required Description
Path String Yes The relative path in the configuration file. You can specify a location of a directory relative to another directory.
Content String No The content of the configuration file. Maximum size: 32 KB.

Event

You cannot specify the Event data type as a request data type. It can be used as a response data type.

Member Type Description
Count Integer The number of events.
FirstTimestamp String The start time of the event.
LastTimestamp String The end time of the event.
Message String The message of the event.
Name String The name of the object that is relevant to the event.
Type String The type of event. Valid values: Normal and Warning.
Reason String The name of the event.

Tag

Parameter Type Required Description
Key String Yes The keyword of the tag.
Value String No The value of the tag.

DNSConfig

For more information about the DNS configuration, visit the following link: https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-s-dns-config

Member Type Description
Nameservers String [] The list of IP addresses for DNS servers.
Searches String [] The list of DNS search domains.
Options Option[] The list of options. Each option includes a name and a value. The value is optional.

Option

Member Type Description
Name String The name of the option.
Value String The value of the option.

Container

Member Type Required Description
Commands String[] No The list of commands that you want to send to a container to run. You can specify a maximum of 20 commands. Maximum length per string: 256 characters.
Args String[] No The arguments passed to the commands. A maximum of 10 arguments are supported.
EnvironmentVars EnvironmentVar[] No Environment variables in the operating system of the container. Each environment variable is a key/value pair, and both the key and value are strings. A maximum of 100 environment variables are supported. The key indicates the name of a variable. The value indicates the value of the variable.
Image String Yes The container image.
Name String Yes The name of the container.
Cpu Float Yes The number of vCPUs assigned to the container. Unit: vCPUs (cores).
Memory Float Yes The memory assigned to the container. Unit: GiB.
ImagePullPolicy String No The image pull policy. You can use it to pull the image from the image repository.
VolumeMounts VolumeMount[] No The number of volumes that are mounted to the container. A maximum of 16 volumes are supported.
CurrentState ContainerState No The current status of the container.
PreviousState ContainerState No The previous status of the container.
RestartCount Integer No The number of the restarts.
WorkingDir String No The working directory for the container.
Ports Port[] No The open ports and protocols. You can set a maximum of 100 ports.
LivenessProbe LivenessProbe No The liveness probe.
ReadinessProbe ReadinessProbe No The readiness probe.
SecurityContext SecurityContext No The security context. For more information about the security context of a container group, see Security context.

ContainerState

You cannot specify the ContainerState data type as a request data type. It can only be used as a response data type.

Parameter Type Description
StartTime Timestamp The time at which the container starts running.
State String The status of the container. Valid values: Waiting, Running, and Terminated.
DetailStatus String The details for the container status.
FinishTime Timestamp The time at which the container stops running.
ExitCode Integer The exit code for the container.
Reason String The container status.
Message String A summary of the container status.
Signal Integer The signal of the container status.

VolumeMount

Parameter Type Required Description
Name String Yes The name of the volume. The name is the same as that specified for the Name parameter in the Volume section.
MountPath String Yes A mount path. The data in the target directory is overwritten by the data in the mounted volume. Therefore, use caution when you mount a volume to a directory.
ReadOnly Boolean Yes Default value: False.

EnvironmentVar

Parameter Type Required Description
Key String Yes The name of the variable. The name must be [1,128] characters in length and can contain [, 0-9a-zA-Z, ], and underscores (_). It cannot start with a digit.
Value String No The value of the variable. The value must be [0,256] characters in length.
FieldRef.FieldPath String No A reference to another variable. Currently, only status.podIP is supported.

Port

Member Type Description
Port Integer The port number. Valid values: 1-65535.
Protocol String The protocol that the port uses. Valid values: TCP and UDP

SecurityContext

Member Type Description
Capability Capability The vCPUs and memory.
RunAsUser Int Valid value: 1337.
ReadOnlyRootFilesystem BOOL Valid value: True.

Capability

Member Type Description
Adds String[] Valid values: .NET_ADMIN.

ReadinessProbe

Parameter Type Description
ReadinessProbe.HttpGet.Path String The path to which the system sends an HTTP GET request to perform the check.
ReadinessProbe.HttpGet.Port Integer The port to which the system sends an HTTP GET request to perform the check.
ReadinessProbe.HttpGet.Scheme String The protocol that is used to connect the host. Valid values: HTTP and HTTPS.
ReadinessProbe.Exec.Commands String [] The commands for running the readiness probe.
ReadinessProbe.TcpSocket.Port Integer The port to which the system sends a TCP SOCKET request to perform the check.
Note: you can use the EXEC commands, HTTP GET request, or TCP SOCKET request to perform the check.
ReadinessProbe.InitialDelaySeconds Integer The number of seconds after the container has started before liveness probes are initiated.
ReadinessProbe.PeriodSecondsT Integer Specifies the period at which the probe is performed. Unit: seconds. Default value: 10. Minimum value: 1.
ReadinessProbe.SuccessThreshold Integer The minimum consecutive successes for the probe to be considered successful after having failed. Default value: 1.
ReadinessProbe.FailureThreshold Integer The minimum consecutive failures for the probe to be considered to have failed after having succeeded. Default value: 3.
ReadinessProbe.TimeoutSeconds Integer The number of seconds after which the probe times out. Default value: 1. Minimum value: 1.

LivenessProbe

Member Type Description
LivenessProbe.HttpGet.Path String The path to which the system sends an HTTP GET request to perform the check.
LivenessProbe.HttpGet.Port Integer The port to which the system sends an HTTP GET request to perform the check.
LivenessProbe.HttpGet.Scheme String Specifies whether the probe uses HTTP or HTTPS.
LivenessProbe.Exec.Commands String [] The commands for running the liveness probe.
LivenessProbe.TcpSocket.Port Integer The port to which the system sends a TCP SOCKET request to perform the check.
LivenessProbe.InitialDelaySeconds Integer The number of seconds after the container has started before liveness probes are initiated.
LivenessProbe.PeriodSeconds Integer Specifies the period at which the probe is performed. Unit: seconds. Default value: 10. Minimum value: 1.
LivenessProbe.SuccessThreshold Integer The minimum consecutive successes for the probe to be considered successful after having failed. Default value: 1. The current threshold must be 1.
LivenessProbe.FailureThreshold Integer The minimum consecutive failures for the probe to be considered failed after having succeeded. Default value: 3.
LivenessProbe.TimeoutSeconds Integer The number of seconds after which the probe times out. Default value: 1. Minimum value: 1.