Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ContainerInstance

A container instance to host containers.

If you delete a container instance, the record remains visible for a short period of time before being permanently removed.

Properties

availabilityDomain

availabilityDomain: string

The availability domain to place the container instance.

compartmentId

compartmentId: string

The OCID of the compartment.

containerCount

containerCount: number

The number of containers on the container instance. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

containerRestartPolicy

containerRestartPolicy: ContainerRestartPolicy

The container restart policy is applied for all containers in container instance.

containers

containers: Array<ContainerInstanceContainer>

The containers on the container instance.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {@code {"foo-namespace": {"bar-key": "value"}}}.

displayName

displayName: string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Optional dnsConfig

dnsConfig: model.ContainerDnsConfig

Optional faultDomain

faultDomain: undefined | string

The fault domain to place the container instance.

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

Optional gracefulShutdownTimeoutInSeconds

gracefulShutdownTimeoutInSeconds: undefined | number

The amount of time that processes in a container have to gracefully end when the container must be stopped. For example, when you delete a container instance. After the timeout is reached, the processes are sent a signal to be deleted. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

id

id: string

An OCID that cannot be changed.

Optional imagePullSecrets

imagePullSecrets: Array<ImagePullSecret>

The image pulls secrets so you can access private registry to pull container images.

Optional lifecycleDetails

lifecycleDetails: undefined | string

A message that describes the current state of the container in more detail. Can be used to provide actionable information.

lifecycleState

lifecycleState: LifecycleState

The current state of the container instance.

shape

shape: string

The shape of the container instance. The shape determines the number of OCPUs, amount of memory, and other resources that are allocated to a container instance.

shapeConfig

Optional systemTags

systemTags: undefined | object

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {@code {"orcl-cloud": {"free-tier-retained": "true"}}}.

timeCreated

timeCreated: Date

The time the container instance was created, in the format defined by RFC 3339.

Optional timeUpdated

timeUpdated: Date

The time the container instance was updated, in the format defined by RFC 3339.

vnics

vnics: Array<ContainerVnic>

The virtual networks available to the containers in the container instance.

Optional volumeCount

volumeCount: undefined | number

The number of volumes that are attached to the container instance. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional volumes

A volume is a directory with data that is accessible across multiple containers in a container instance.

Functions

getDeserializedJsonObj

getJsonObj