Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ContainerSummary

Summary information about a container.

Properties

availabilityDomain

availabilityDomain: string

The availability domain where the container instance that hosts this container runs.

compartmentId

compartmentId: string

The compartment OCID.

containerInstanceId

containerInstanceId: string

The OCID of the container instance on which the container is running.

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 that hosts the container 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"}}

id

id: string

The OCID of the container.

imageUrl

imageUrl: string

A URL identifying the image that the container runs in, such as docker.io/library/busybox:latest. If you do not provide a tag, the tag will default to latest.

If no registry is provided, will default the registry to public docker hub {@code docker.io/library}. The registry used for container image must be reachable over the Container Instance's VNIC.

Optional isResourcePrincipalDisabled

isResourcePrincipalDisabled: undefined | false | true

Determines whether the container will have access to the container instance resource principal.

This method utilizes resource principal version 2.2. For information on how to use the exposed resource principal elements, see https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm#sdk_authentication_methods_resource_principal.

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: string

The current state of the container.

Optional resourceConfig

resourceConfig: model.ContainerResourceConfig

Optional securityContext

securityContext: model.LinuxSecurityContext

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 the container was created in the format defined by RFC 3339.

Optional timeUpdated

timeUpdated: Date

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

Functions

getDeserializedJsonObj

getJsonObj