Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ContainerInstanceSummary

A set of details about a single container instance returned by list APIs.

Properties

availabilityDomain

availabilityDomain: string

The availability domain where the container instance runs.

compartmentId

compartmentId: string

The OCID of the compartment to create the container instance in.

containerCount

containerCount: number

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

containerRestartPolicy

containerRestartPolicy: string

Container Restart Policy

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 faultDomain

faultDomain: undefined | string

The fault domain where the container instance runs.

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

OCID that cannot be changed.

Optional lifecycleDetails

lifecycleDetails: undefined | string

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

lifecycleState

lifecycleState: string

The current state of the container instance.

shape

shape: string

The shape of the container instance. The shape determines the resources available to the 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 RFC3339.

Optional timeUpdated

timeUpdated: Date

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

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.

Functions

getDeserializedJsonObj

getJsonObj