Jump to

• Request
• Response

Creates a new ContainerInstance

post

/20210415/containerInstances

Creates a container instance and deploys the containers on it.

Request

Supported Media Types

• application/json

Header Parameters

• opc-fleet-id: string
  The fleet id for targeted launch.
• opc-host-serial: string
  The ID of the hypervisor.
• opc-pool-name: string
  The pool name for targeted launch.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.
• opc-retry-token: string
  Minimum Length: 1

  Maximum Length: 64

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

Body ()

Details for the new container instance.

Root Schema : CreateContainerInstanceDetails

Type: object

Information to create a container instance.

Show Source

• availabilityDomain(required): string
  Minimum Length: 1

  Maximum Length: 255

  The availability domain where the container instance runs.
• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The compartment OCID.
• containerRestartPolicy: string
  Default Value: ALWAYS

  Container restart policy
• containers(required): array containers
  Minimum Number of Items: 1

  Maximum Number of Items: 60

  The containers to create on this container instance.
• definedTags: object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`.
• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. If you don't provide a name, a name is generated automatically.
• dnsConfig: object CreateContainerDnsConfigDetails
  Allow customers to define DNS settings for containers. If this is not provided, the containers use the default DNS settings of the subnet.
• faultDomain: string
  Minimum Length: 1

  Maximum Length: 255

  The fault domain where the container instance runs.
• freeformTags: object freeformTags
  Additional Properties Allowed: additionalProperties

  Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
• gracefulShutdownTimeoutInSeconds: integer(int64)
  Minimum Value: 0

  Maximum Value: 3600

  Default Value: 0

  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.
• imagePullSecrets: array imagePullSecrets
  The image pulls secrets so you can access private registry to pull container images.
• securityContext: object CreateContainerInstanceSecurityContextDetails
  Discriminator: securityContextType

  Security context for all containers in a container instance.
• shape(required): string
  The shape of the container instance. The shape determines the resources available to the container instance.
• shapeConfig(required): object CreateContainerInstanceShapeConfigDetails
  The size and amount of resources available to the container instance.
• streamId: string
  Minimum Length: 1

  Maximum Length: 255

  Default Value: oracle.doceng.json.BetterJsonNull@6601cc93

  Customer's streaming OCID which is used for receiving a message whenever container health check status changes.
• vnics(required): array vnics
  Minimum Number of Items: 1

  Maximum Number of Items: 24

  The networks available to containers on this container instance.
• volumes: array volumes
  Maximum Number of Items: 32

  A volume is a directory with data that is accessible across multiple containers in a container instance. You can attach up to 32 volumes to single container instance.

{
    "description":"Information to create a container instance.",
    "type":"object",
    "required":[
        "compartmentId",
        "availabilityDomain",
        "shape",
        "shapeConfig",
        "containers",
        "vnics"
    ],
    "properties":{
        "displayName":{
            "description":"A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. If you don't provide a name, a name is generated automatically. ",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "compartmentId":{
            "description":"The compartment OCID.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "availabilityDomain":{
            "description":"The availability domain where the container instance runs.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "faultDomain":{
            "description":"The fault domain where the container instance runs. ",
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "x-default-description":"If you do not specify the fault domain, the system selects one for you."
        },
        "shape":{
            "description":"The shape of the container instance. The shape determines the resources available to the container instance.",
            "type":"string"
        },
        "shapeConfig":{
            "$ref":"#/definitions/CreateContainerInstanceShapeConfigDetails"
        },
        "volumes":{
            "description":"A volume is a directory with data that is accessible across multiple containers in a container instance.  You can attach up to 32 volumes to single container instance. ",
            "type":"array",
            "items":{
                "$ref":"#/definitions/CreateContainerVolumeDetails"
            },
            "default":null,
            "maxItems":32
        },
        "containers":{
            "description":"The containers to create on this container instance.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/CreateContainerDetails"
            },
            "minItems":1,
            "maxItems":60
        },
        "vnics":{
            "description":"The networks available to containers on this container instance.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/CreateContainerVnicDetails"
            },
            "minItems":1,
            "maxItems":24
        },
        "dnsConfig":{
            "$ref":"#/definitions/CreateContainerDnsConfigDetails"
        },
        "gracefulShutdownTimeoutInSeconds":{
            "description":"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.",
            "type":"integer",
            "format":"int64",
            "default":0,
            "minimum":0,
            "maximum":3600
        },
        "imagePullSecrets":{
            "description":"The image pulls secrets so you can access private registry to pull container images.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/CreateImagePullSecretDetails"
            },
            "default":null
        },
        "containerRestartPolicy":{
            "description":"Container restart policy",
            "type":"string",
            "x-obmcs-enumref":"#/definitions/ContainerInstance/containerRestartPolicy",
            "default":"ALWAYS"
        },
        "streamId":{
            "description":"Customer's streaming OCID which is used for receiving a message whenever container health check status changes. ",
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "default":null
        },
        "freeformTags":{
            "description":"Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`. ",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{\"bar-key\": \"value\"}`. ",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only string, integer, and boolean types are supported. "
                }
            }
        },
        "securityContext":{
            "$ref":"#/definitions/CreateContainerInstanceSecurityContextDetails"
        }
    }
}

Nested Schema : containers

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 60

The containers to create on this container instance.

Show Source

• Array of: object CreateContainerDetails
  Information to create a new container within a container instance. The container created by this call contains both the tags specified in this object and any tags specified in the parent container instance. The container is created in the same compartment, availability domain, and fault domain as its container instance.

{
    "description":"The containers to create on this container instance.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/CreateContainerDetails"
    },
    "minItems":1,
    "maxItems":60
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`.

{
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`. ",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{\"bar-key\": \"value\"}`. ",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only string, integer, and boolean types are supported. "
        }
    }
}

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

Nested Schema : CreateContainerDnsConfigDetails

Type: object

Allow customers to define DNS settings for containers. If this is not provided, the containers use the default DNS settings of the subnet.

Show Source

• nameservers: array nameservers
  Maximum Number of Items: 3

  Unique Items Required: true

  IP address of a name server that the resolver should query, either an IPv4 address (in dot notation), or an IPv6 address in colon (and possibly dot) notation. If null, uses nameservers from subnet dhcpDnsOptions.
• options: array options
  Maximum Number of Items: 16

  Unique Items Required: true

  Options allows certain internal resolver variables to be modified. Options are a list of objects in https://man7.org/linux/man-pages/man5/resolv.conf.5.html. Examples: ["ndots:n", "edns0"].
• searches: array searches
  Maximum Number of Items: 6

  Unique Items Required: true

  Search list for host-name lookup. If null, we will use searches from subnet dhcpDnsOptios.

{
    "description":"Allow customers to define DNS settings for containers. If this is not provided, the containers use the default DNS settings of the subnet. ",
    "type":"object",
    "properties":{
        "nameservers":{
            "description":"IP address of a name server that the resolver should query, either an IPv4 address (in dot notation), or an IPv6 address in colon (and possibly dot) notation. If null, uses nameservers from subnet dhcpDnsOptions. ",
            "type":"array",
            "items":{
                "type":"string",
                "minLength":1,
                "maxLength":50
            },
            "maxItems":3,
            "uniqueItems":true,
            "x-default-description":"null"
        },
        "searches":{
            "description":"Search list for host-name lookup. If null, we will use searches from subnet dhcpDnsOptios.",
            "type":"array",
            "items":{
                "type":"string",
                "minLength":1,
                "maxLength":253
            },
            "maxItems":6,
            "uniqueItems":true,
            "x-default-description":"null"
        },
        "options":{
            "description":"Options allows certain internal resolver variables to be modified. Options are a list of objects in https://man7.org/linux/man-pages/man5/resolv.conf.5.html. Examples: [\"ndots:n\", \"edns0\"]. ",
            "type":"array",
            "items":{
                "type":"string",
                "minLength":1,
                "maxLength":25
            },
            "maxItems":16,
            "uniqueItems":true,
            "x-default-description":"null"
        }
    }
}

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

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

Nested Schema : imagePullSecrets

Type: array

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

Default Value: oracle.doceng.json.BetterJsonNull@5e5073ab

Show Source

• Array of: object CreateImagePullSecretDetails
  Discriminator: secretType

  The image pull secrets for accessing private registry to pull images for containers

{
    "description":"The image pulls secrets so you can access private registry to pull container images.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/CreateImagePullSecretDetails"
    },
    "default":null
}

Nested Schema : CreateContainerInstanceSecurityContextDetails

Type: object

Discriminator: securityContextType

Security context for all containers in a container instance.

Show Source

• securityContextType: string
  Default Value: LINUX

  The type of security context

{
    "description":"Security context for all containers in a container instance.",
    "discriminator":"securityContextType",
    "properties":{
        "securityContextType":{
            "description":"The type of security context",
            "type":"string",
            "x-obmcs-enumref":"#/definitions/ContainerInstanceSecurityContext/securityContextType",
            "default":"LINUX"
        }
    },
    "type":"object"
}

Nested Schema : CreateContainerInstanceShapeConfigDetails

Type: object

The size and amount of resources available to the container instance.

Show Source

• memoryInGBs: number(float)
  Minimum Value: 0

  The total amount of memory available to the container instance (GB).
• ocpus(required): number(float)
  Minimum Value: 0

  The total number of OCPUs available to the container instance.

{
    "description":"The size and amount of resources available to the container instance. ",
    "required":[
        "ocpus"
    ],
    "properties":{
        "ocpus":{
            "description":"The total number of OCPUs available to the container instance. ",
            "format":"float",
            "minimum":0,
            "type":"number"
        },
        "memoryInGBs":{
            "description":"The total amount of memory available to the container instance (GB). ",
            "format":"float",
            "minimum":0,
            "type":"number",
            "x-default-description":"A default value is chosen based on the number of OCPUs selected."
        }
    },
    "type":"object"
}

Nested Schema : vnics

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 24

The networks available to containers on this container instance.

Show Source

• Array of: object CreateContainerVnicDetails
  Information to create a virtual network interface card (VNIC) which gives the containers on this container instance access to a virtual client network (VCN). You use this object when creating the primary VNIC during container instance launch or when creating a secondary VNIC. This VNIC is created in the same compartment as the specified subnet on behalf of the customer. The VNIC created by this call contains both the tags specified in this object as well as any tags specified in the parent container instance.

{
    "description":"The networks available to containers on this container instance.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/CreateContainerVnicDetails"
    },
    "minItems":1,
    "maxItems":24
}

Nested Schema : volumes

Type: array

Maximum Number of Items: 32

A volume is a directory with data that is accessible across multiple containers in a container instance. You can attach up to 32 volumes to single container instance.

Default Value: oracle.doceng.json.BetterJsonNull@5432c277

Show Source

• Array of: object CreateContainerVolumeDetails
  Discriminator: volumeType

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

{
    "description":"A volume is a directory with data that is accessible across multiple containers in a container instance.  You can attach up to 32 volumes to single container instance. ",
    "type":"array",
    "items":{
        "$ref":"#/definitions/CreateContainerVolumeDetails"
    },
    "default":null,
    "maxItems":32
}

Nested Schema : CreateContainerDetails

Type: object

Information to create a new container within a container instance. The container created by this call contains both the tags specified in this object and any tags specified in the parent container instance. The container is created in the same compartment, availability domain, and fault domain as its container instance.

Show Source

• additionalCapabilities: array additionalCapabilities
  Additional capabilities that can be configured for the container.
• arguments: array arguments
  A list of string arguments for a container's ENTRYPOINT process. Many containers use an ENTRYPOINT process pointing to a shell (/bin/bash). For those containers, this argument list specifies the main command in the container process. The total size of all arguments combined must be 64 KB or smaller.
• command: array command
  An optional command that overrides the ENTRYPOINT process. If you do not provide a value, the existing ENTRYPOINT process defined in the image is used.
• definedTags: object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`.
• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. If you don't provide a name, a name is generated automatically.
• environmentVariables: object environmentVariables
  Additional Properties Allowed: additionalProperties

  A map of additional environment variables to set in the environment of the container's ENTRYPOINT process. These variables are in addition to any variables already defined in the container's image. The total size of all environment variables combined, name and values, must be 64 KB or smaller.
• freeformTags: object freeformTags
  Additional Properties Allowed: additionalProperties

  Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
• healthChecks: array healthChecks
  list of container health checks to check container status and take appropriate action if container status is failed. There are two types of health checks that we currently support HTTP and TCP.
• imageUrl(required): string
  Minimum Length: 1

  Maximum Length: 1024

  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 `docker.io/library`. The registry used for container image must be reachable over the Container Instance's VNIC.
• isPkiCertsProvided: boolean
  Default Value: false

  A flag to indicate whether PKI certs and regionInfo related files are mounted to the container.
• isResourcePrincipalDisabled: boolean
  Default Value: false

  Determines if 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.
• resourceConfig: object CreateContainerResourceConfigDetails
  The size and amount of resources available to the container.
• securityContext: object CreateSecurityContextDetails
  Discriminator: securityContextType

  Security context for container.
• volumeMounts: array volumeMounts
  List of the volume mounts.
• workingDirectory: string
  Minimum Length: 1

  Maximum Length: 4096

  Default Value: oracle.doceng.json.BetterJsonNull@1046498a

  The working directory within the container's filesystem for the container process. If not specified, the default working directory from the image is used.

{
    "description":"Information to create a new container within a container instance.  The container created by this call contains both the tags specified in this object and any tags specified in the parent container instance.  The container is created in the same compartment, availability domain, and fault domain as its container instance. ",
    "type":"object",
    "required":[
        "imageUrl"
    ],
    "properties":{
        "displayName":{
            "description":"A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. If you don't provide a name, a name is generated automatically. ",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "imageUrl":{
            "description":"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 `docker.io/library`.  The registry used for container image must be reachable over the Container Instance's VNIC. ",
            "type":"string",
            "minLength":1,
            "maxLength":1024
        },
        "command":{
            "description":"An optional command that overrides the ENTRYPOINT process. If you do not provide a value, the existing ENTRYPOINT process defined in the image is used. ",
            "type":"array",
            "items":{
                "type":"string"
            },
            "default":null
        },
        "arguments":{
            "description":"A list of string arguments for a container's ENTRYPOINT process.  Many containers use an ENTRYPOINT process pointing to a shell (/bin/bash). For those containers, this argument list specifies the main command in the container process.  The total size of all arguments combined must be 64 KB or smaller. ",
            "type":"array",
            "items":{
                "type":"string"
            },
            "default":null
        },
        "additionalCapabilities":{
            "description":"Additional capabilities that can be configured for the container. ",
            "type":"array",
            "items":{
                "type":"string",
                "x-obmcs-top-level-enum":"#/definitions/ContainerCapability",
                "enum":[
                    "CAP_NET_ADMIN",
                    "CAP_NET_RAW"
                ]
            },
            "default":null
        },
        "isPkiCertsProvided":{
            "description":"A flag to indicate whether PKI certs and regionInfo related files are mounted to the container. ",
            "type":"boolean",
            "default":false
        },
        "workingDirectory":{
            "description":"The working directory within the container's filesystem for the container process. If not specified, the default working directory from the image is used. ",
            "type":"string",
            "minLength":1,
            "maxLength":4096,
            "default":null
        },
        "environmentVariables":{
            "description":"A map of additional environment variables to set in the environment of the container's ENTRYPOINT process. These variables are in addition to any variables already defined in the container's image.  The total size of all environment variables combined, name and values, must be 64 KB or smaller. ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "default":null
        },
        "volumeMounts":{
            "description":"List of the volume mounts. ",
            "type":"array",
            "items":{
                "$ref":"#/definitions/CreateVolumeMountDetails"
            },
            "default":null
        },
        "isResourcePrincipalDisabled":{
            "description":"Determines if 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. ",
            "type":"boolean",
            "default":false
        },
        "resourceConfig":{
            "$ref":"#/definitions/CreateContainerResourceConfigDetails"
        },
        "healthChecks":{
            "description":"list of container health checks to check container status and take appropriate action if container status is failed. There are two types of health checks that we currently support HTTP and TCP. ",
            "type":"array",
            "items":{
                "$ref":"#/definitions/CreateContainerHealthCheckDetails"
            }
        },
        "securityContext":{
            "$ref":"#/definitions/CreateSecurityContextDetails"
        },
        "freeformTags":{
            "description":"Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`. ",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{\"bar-key\": \"value\"}`. ",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only string, integer, and boolean types are supported. "
                }
            }
        }
    }
}

Nested Schema : additionalCapabilities

Type: array

Additional capabilities that can be configured for the container.

Default Value: oracle.doceng.json.BetterJsonNull@1639f93a

Show Source

• Array of: string
  Allowed Values: [ "CAP_NET_ADMIN", "CAP_NET_RAW" ]

{
    "description":"Additional capabilities that can be configured for the container. ",
    "type":"array",
    "items":{
        "type":"string",
        "x-obmcs-top-level-enum":"#/definitions/ContainerCapability",
        "enum":[
            "CAP_NET_ADMIN",
            "CAP_NET_RAW"
        ]
    },
    "default":null
}

Nested Schema : arguments

Type: array

A list of string arguments for a container's ENTRYPOINT process. Many containers use an ENTRYPOINT process pointing to a shell (/bin/bash). For those containers, this argument list specifies the main command in the container process. The total size of all arguments combined must be 64 KB or smaller.

Default Value: oracle.doceng.json.BetterJsonNull@22590e3e

Show Source

• Array of: string

{
    "description":"A list of string arguments for a container's ENTRYPOINT process.  Many containers use an ENTRYPOINT process pointing to a shell (/bin/bash). For those containers, this argument list specifies the main command in the container process.  The total size of all arguments combined must be 64 KB or smaller. ",
    "type":"array",
    "items":{
        "type":"string"
    },
    "default":null
}

Nested Schema : command

Type: array

An optional command that overrides the ENTRYPOINT process. If you do not provide a value, the existing ENTRYPOINT process defined in the image is used.

Default Value: oracle.doceng.json.BetterJsonNull@2b329bbd

Show Source

• Array of: string

{
    "description":"An optional command that overrides the ENTRYPOINT process. If you do not provide a value, the existing ENTRYPOINT process defined in the image is used. ",
    "type":"array",
    "items":{
        "type":"string"
    },
    "default":null
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`.

{
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`. ",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{\"bar-key\": \"value\"}`. ",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only string, integer, and boolean types are supported. "
        }
    }
}

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

Nested Schema : environmentVariables

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"A map of additional environment variables to set in the environment of the container's ENTRYPOINT process. These variables are in addition to any variables already defined in the container's image.  The total size of all environment variables combined, name and values, must be 64 KB or smaller. ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "default":null
}

A map of additional environment variables to set in the environment of the container's ENTRYPOINT process. These variables are in addition to any variables already defined in the container's image. The total size of all environment variables combined, name and values, must be 64 KB or smaller.

Default Value: oracle.doceng.json.BetterJsonNull@7e1f584d

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

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

Nested Schema : healthChecks

Type: array

list of container health checks to check container status and take appropriate action if container status is failed. There are two types of health checks that we currently support HTTP and TCP.

Show Source

• Array of: object CreateContainerHealthCheckDetails
  Discriminator: healthCheckType

  Container Health Check is used to check and report the status of a container.

{
    "description":"list of container health checks to check container status and take appropriate action if container status is failed. There are two types of health checks that we currently support HTTP and TCP. ",
    "type":"array",
    "items":{
        "$ref":"#/definitions/CreateContainerHealthCheckDetails"
    }
}

Nested Schema : CreateContainerResourceConfigDetails

Type: object

The size and amount of resources available to the container.

Show Source

• memoryLimitInGBs: number(float)
  Minimum Value: 0

  Default Value: oracle.doceng.json.BetterJsonNull@7e736350

  The maximum amount of memory that can be consumed by the container's process. If you do not set a value, then the process may use all available memory on the instance.
• vcpusLimit: number(float)
  Minimum Value: 0

  Default Value: oracle.doceng.json.BetterJsonNull@3874b815

  The maximum amount of CPUs that can be consumed by the container's process. If you do not set a value, then the process can use all available CPU resources on the instance. CPU usage is defined in terms of logical CPUs. This means that the maximum possible value on an E3 ContainerInstance with 1 OCPU is 2.0. A container with a 2.0 vcpusLimit could consume up to 100% of the CPU resources available on the container instance. Values can be fractional. A value of "1.5" means that the container can consume at most the equivalent of 1 and a half logical CPUs worth of CPU capacity.

{
    "description":"The size and amount of resources available to the container. ",
    "properties":{
        "vcpusLimit":{
            "description":"The maximum amount of CPUs that can be consumed by the container's process.  If you do not set a value, then the process can use all available CPU resources on the instance.  CPU usage is defined in terms of logical CPUs. This means that the maximum possible value on an E3 ContainerInstance with 1 OCPU is 2.0.  A container with a 2.0 vcpusLimit could consume up to 100% of the CPU resources available on the container instance. Values can be fractional. A value of \"1.5\" means that the container can consume at most the equivalent of 1 and a half logical CPUs worth of CPU capacity. ",
            "format":"float",
            "minimum":0,
            "type":"number",
            "default":null
        },
        "memoryLimitInGBs":{
            "description":"The maximum amount of memory that can be consumed by the container's process.  If you do not set a value, then the process may use all available memory on the instance. ",
            "format":"float",
            "minimum":0,
            "type":"number",
            "default":null
        }
    },
    "type":"object"
}

Nested Schema : CreateSecurityContextDetails

Type: object

Discriminator: securityContextType

Security context for container.

Show Source

• securityContextType: string
  Default Value: LINUX

  The type of security context

{
    "description":"Security context for container.",
    "discriminator":"securityContextType",
    "properties":{
        "securityContextType":{
            "description":"The type of security context",
            "type":"string",
            "x-obmcs-enumref":"#/definitions/SecurityContext/securityContextType",
            "default":"LINUX"
        }
    },
    "type":"object"
}

Nested Schema : volumeMounts

Type: array

List of the volume mounts.

Default Value: oracle.doceng.json.BetterJsonNull@47b179d7

Show Source

• Array of: object CreateVolumeMountDetails
  Defines the mapping from volume to a mount path in a container.

{
    "description":"List of the volume mounts. ",
    "type":"array",
    "items":{
        "$ref":"#/definitions/CreateVolumeMountDetails"
    },
    "default":null
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only string, integer, and boolean types are supported.

{
    "type":"object",
    "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{\"bar-key\": \"value\"}`. ",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only string, integer, and boolean types are supported. "
    }
}

Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`.

Nested Schema : additionalProperties

Type: object

The value of the tag. Only string, integer, and boolean types are supported.

Nested Schema : CreateContainerHealthCheckDetails

Type: object

Discriminator: healthCheckType

Container Health Check is used to check and report the status of a container.

Show Source

• failureAction: string
  Default Value: KILL

  Allowed Values: [ "KILL", "NONE" ]

  The action will be triggered when the container health check fails. There are two types of action: KILL or NONE. The default action is KILL. If failure action is KILL, the container will be subject to the container restart policy.
• failureThreshold: integer
  Minimum Value: 1

  Default Value: 3

  Number of consecutive failures at which we consider the check failed.
• healthCheckType(required): string
  Allowed Values: [ "HTTP", "TCP", "COMMAND" ]

  Container health check type.
• initialDelayInSeconds: integer
  Minimum Value: 0

  Default Value: 0

  The initial delay in seconds before start checking container health status.
• intervalInSeconds: integer
  Minimum Value: 1

  Default Value: 10

  Number of seconds between two consecutive runs for checking container health.
• isStartupCheck: boolean
  Default Value: false

  If set to true, this health check runs first while other HealthChecks wait for this one to complete. If this becomes Healthy then other health checks are started. If it becomes Unhealthy the container is killed. At max only 1 healthCheck can have this field set to true.
• name: string
  Minimum Length: 1

  Maximum Length: 255

  Health check name.
• successThreshold: integer
  Minimum Value: 1

  Default Value: 1

  Number of consecutive successes at which we consider the check succeeded again after it was in failure state.
• timeoutInSeconds: integer
  Minimum Value: 1

  Default Value: 1

  Length of waiting time in seconds before marking health check failed.

{
    "description":"Container Health Check is used to check and report the status of a container. ",
    "discriminator":"healthCheckType",
    "required":[
        "healthCheckType"
    ],
    "properties":{
        "name":{
            "description":"Health check name.",
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "x-default-description":"A default value will be generated from our backend code"
        },
        "healthCheckType":{
            "description":"Container health check type.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/ContainerHealthCheckType",
            "enum":[
                "HTTP",
                "TCP",
                "COMMAND"
            ]
        },
        "isStartupCheck":{
            "description":"If set to true, this health check runs first while other HealthChecks wait for this one to complete.  If this becomes Healthy then other health checks are started.  If it becomes Unhealthy the container is killed. At max only 1 healthCheck can have this field set to true. ",
            "type":"boolean",
            "default":false
        },
        "initialDelayInSeconds":{
            "description":"The initial delay in seconds before start checking container health status.",
            "type":"integer",
            "minimum":0,
            "default":0
        },
        "intervalInSeconds":{
            "description":"Number of seconds between two consecutive runs for checking container health.",
            "type":"integer",
            "minimum":1,
            "default":10
        },
        "failureThreshold":{
            "description":"Number of consecutive failures at which we consider the check failed.",
            "type":"integer",
            "minimum":1,
            "default":3
        },
        "successThreshold":{
            "description":"Number of consecutive successes at which we consider the check succeeded again after it was in failure state.",
            "type":"integer",
            "minimum":1,
            "default":1
        },
        "timeoutInSeconds":{
            "description":"Length of waiting time in seconds before marking health check failed.",
            "type":"integer",
            "minimum":1,
            "default":1
        },
        "failureAction":{
            "description":"The action will be triggered when the container health check fails. There are two types of action: KILL or NONE. The default action is KILL. If failure action is KILL, the container will be subject to the container restart policy. ",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/ContainerHealthCheckFailureAction",
            "enum":[
                "KILL",
                "NONE"
            ],
            "default":"KILL"
        }
    },
    "type":"object"
}

Nested Schema : CreateVolumeMountDetails

Type: object

Defines the mapping from volume to a mount path in a container.

Show Source

• isReadOnly: boolean
  Default Value: false

  Whether the volume was mounted in read-only mode. By default, the volume is not read-only.
• mountPath(required): string
  Minimum Length: 1

  Maximum Length: 4096

  The volume access path.
• partition: integer(int32)
  Minimum Value: 1

  Maximum Value: 128

  Default Value: 1

  If there is more than one partition in the volume, reference this number of partitions. Here is an example: Number Start End Size File system Name Flags 1 1049kB 106MB 105MB fat16 EFI System Partition boot, esp 2 106MB 1180MB 1074MB xfs 3 1180MB 50.0GB 48.8GB lvm
• subPath: string
  Minimum Length: 1

  Maximum Length: 4096

  Default Value: oracle.doceng.json.BetterJsonNull@6107165

  A subpath inside the referenced volume.
• volumeName(required): string
  Minimum Length: 1

  Maximum Length: 256

  The name of the volume. Avoid entering confidential information.

{
    "description":"Defines the mapping from volume to a mount path in a container. ",
    "required":[
        "mountPath",
        "volumeName"
    ],
    "properties":{
        "mountPath":{
            "description":"The volume access path.",
            "type":"string",
            "minLength":1,
            "maxLength":4096
        },
        "volumeName":{
            "description":"The name of the volume. Avoid entering confidential information.",
            "type":"string",
            "minLength":1,
            "maxLength":256
        },
        "subPath":{
            "description":"A subpath inside the referenced volume.",
            "type":"string",
            "minLength":1,
            "maxLength":4096,
            "default":null
        },
        "isReadOnly":{
            "description":"Whether the volume was mounted in read-only mode. By default, the volume is not read-only.",
            "type":"boolean",
            "default":false
        },
        "partition":{
            "description":"If there is more than one partition in the volume, reference this number of partitions. Here is an example: Number  Start   End     Size    File system  Name                  Flags 1      1049kB  106MB   105MB   fat16        EFI System Partition  boot, esp 2      106MB   1180MB  1074MB  xfs 3      1180MB  50.0GB  48.8GB                                     lvm ",
            "type":"integer",
            "format":"int32",
            "minimum":1,
            "maximum":128,
            "default":1
        }
    },
    "type":"object"
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only string, integer, and boolean types are supported.

{
    "type":"object",
    "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{\"bar-key\": \"value\"}`. ",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only string, integer, and boolean types are supported. "
    }
}

Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`.

Nested Schema : additionalProperties

Type: object

The value of the tag. Only string, integer, and boolean types are supported.

Nested Schema : nameservers

Type: array

Maximum Number of Items: 3

Unique Items Required: true

IP address of a name server that the resolver should query, either an IPv4 address (in dot notation), or an IPv6 address in colon (and possibly dot) notation. If null, uses nameservers from subnet dhcpDnsOptions.

Show Source

• Array of: string
  Minimum Length: 1

  Maximum Length: 50

{
    "description":"IP address of a name server that the resolver should query, either an IPv4 address (in dot notation), or an IPv6 address in colon (and possibly dot) notation. If null, uses nameservers from subnet dhcpDnsOptions. ",
    "type":"array",
    "items":{
        "type":"string",
        "minLength":1,
        "maxLength":50
    },
    "maxItems":3,
    "uniqueItems":true,
    "x-default-description":"null"
}

Nested Schema : options

Type: array

Maximum Number of Items: 16

Unique Items Required: true

Options allows certain internal resolver variables to be modified. Options are a list of objects in https://man7.org/linux/man-pages/man5/resolv.conf.5.html. Examples: ["ndots:n", "edns0"].

Show Source

• Array of: string
  Minimum Length: 1

  Maximum Length: 25

{
    "description":"Options allows certain internal resolver variables to be modified. Options are a list of objects in https://man7.org/linux/man-pages/man5/resolv.conf.5.html. Examples: [\"ndots:n\", \"edns0\"]. ",
    "type":"array",
    "items":{
        "type":"string",
        "minLength":1,
        "maxLength":25
    },
    "maxItems":16,
    "uniqueItems":true,
    "x-default-description":"null"
}

Nested Schema : searches

Type: array

Maximum Number of Items: 6

Unique Items Required: true

Search list for host-name lookup. If null, we will use searches from subnet dhcpDnsOptios.

Show Source

• Array of: string
  Minimum Length: 1

  Maximum Length: 253

{
    "description":"Search list for host-name lookup. If null, we will use searches from subnet dhcpDnsOptios.",
    "type":"array",
    "items":{
        "type":"string",
        "minLength":1,
        "maxLength":253
    },
    "maxItems":6,
    "uniqueItems":true,
    "x-default-description":"null"
}

Nested Schema : CreateImagePullSecretDetails

Type: object

Discriminator: secretType

The image pull secrets for accessing private registry to pull images for containers

Show Source

• registryEndpoint(required): string
  The registry endpoint of the container image.
• secretType(required): string
  Allowed Values: [ "BASIC", "VAULT" ]

  The type of ImagePullSecret.

{
    "description":"The image pull secrets for accessing private registry to pull images for containers ",
    "type":"object",
    "discriminator":"secretType",
    "required":[
        "secretType",
        "registryEndpoint"
    ],
    "properties":{
        "secretType":{
            "description":"The type of ImagePullSecret.",
            "type":"string",
            "enum":[
                "BASIC",
                "VAULT"
            ]
        },
        "registryEndpoint":{
            "description":"The registry endpoint of the container image.",
            "type":"string"
        }
    }
}

Nested Schema : CreateContainerVnicDetails

Type: object

Information to create a virtual network interface card (VNIC) which gives the containers on this container instance access to a virtual client network (VCN). You use this object when creating the primary VNIC during container instance launch or when creating a secondary VNIC. This VNIC is created in the same compartment as the specified subnet on behalf of the customer. The VNIC created by this call contains both the tags specified in this object as well as any tags specified in the parent container instance.

Show Source

• definedTags: object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`.
• displayName: string
  A user-friendly name for the VNIC. Does not have to be unique. Avoid entering confidential information.
• freeformTags: object freeformTags
  Additional Properties Allowed: additionalProperties

  Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
• hostnameLabel: string
  The hostname for the VNIC's primary private IP. Used for DNS.
• isPublicIpAssigned: boolean
  Whether the VNIC should be assigned a public IP address.
• nsgIds: array nsgIds
  Maximum Number of Items: 5

  Unique Items Required: true

  A list of the OCIDs of the network security groups (NSGs) to add the VNIC to.
• privateIp: string
  A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR.
• purpose: string
  Default Value: PRIMARY

  Allowed Values: [ "PRIMARY", "SECONDARY" ]

  Designates if the VNIC to be created is Primary or Secondary. Only one VNIC can be designated as Primary when customers request additional VNICs in the request. The container instance uses the primary VNIC for pulling the necessary container images for creating the container instance. Container Instance Service does not use the secondary VNIC(s) but will configure them such that traffic originating from such VNIC(s) will be routed to that VNIC's subnet gateway address.
• skipSourceDestCheck: boolean
  Default Value: false

  Whether the source/destination check is disabled on the VNIC.
• subnetId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the subnet to create the VNIC in.

{
    "description":"Information to create a virtual network interface card (VNIC) which gives the containers on this container instance access to a virtual client network (VCN).  You use this object when creating the primary VNIC during container instance launch or when creating a secondary VNIC. This VNIC is created in the same compartment as the specified subnet on behalf of the customer.  The VNIC created by this call contains both the tags specified in this object as well as any tags specified in the parent container instance. ",
    "type":"object",
    "required":[
        "subnetId"
    ],
    "properties":{
        "displayName":{
            "description":"A user-friendly name for the VNIC. Does not have to be unique. Avoid entering confidential information. ",
            "type":"string"
        },
        "hostnameLabel":{
            "description":"The hostname for the VNIC's primary private IP. Used for DNS. ",
            "type":"string",
            "x-default-description":"A value is set with the format `<vnicDisplayName>-<randomNumber>`."
        },
        "isPublicIpAssigned":{
            "description":"Whether the VNIC should be assigned a public IP address. ",
            "type":"boolean",
            "x-default-description":"True if the subnet is public, false if the subnet is private."
        },
        "skipSourceDestCheck":{
            "description":"Whether the source/destination check is disabled on the VNIC. ",
            "type":"boolean",
            "default":false
        },
        "nsgIds":{
            "description":"A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. ",
            "items":{
                "type":"string",
                "minLength":1,
                "maxLength":255
            },
            "maxItems":5,
            "type":"array",
            "uniqueItems":true,
            "default":null
        },
        "privateIp":{
            "description":"A private IP address of your choice to assign to the VNIC. Must be an available IP address within the subnet's CIDR. ",
            "type":"string",
            "x-default-description":"A available IP address from the subnet will be automatically selected."
        },
        "subnetId":{
            "description":"The OCID of the subnet to create the VNIC in. ",
            "minLength":1,
            "maxLength":255,
            "type":"string"
        },
        "purpose":{
            "description":"Designates if the VNIC to be created is Primary or Secondary. Only one VNIC can be designated as Primary when  customers request additional VNICs in the request. The container instance uses the primary VNIC for pulling  the necessary container images for creating the container instance. Container Instance Service does not use  the secondary VNIC(s) but will configure them such that traffic originating from such VNIC(s) will be routed  to that VNIC's subnet gateway address. ",
            "type":"string",
            "enum":[
                "PRIMARY",
                "SECONDARY"
            ],
            "default":"PRIMARY"
        },
        "freeformTags":{
            "description":"Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`. ",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{\"bar-key\": \"value\"}`. ",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only string, integer, and boolean types are supported. "
                }
            }
        }
    }
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`.

{
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`. ",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{\"bar-key\": \"value\"}`. ",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only string, integer, and boolean types are supported. "
        }
    }
}

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

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

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

Nested Schema : nsgIds

Type: array

Maximum Number of Items: 5

Unique Items Required: true

A list of the OCIDs of the network security groups (NSGs) to add the VNIC to.

Default Value: oracle.doceng.json.BetterJsonNull@15f8701f

Show Source

• Array of: string
  Minimum Length: 1

  Maximum Length: 255

{
    "description":"A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. ",
    "items":{
        "type":"string",
        "minLength":1,
        "maxLength":255
    },
    "maxItems":5,
    "type":"array",
    "uniqueItems":true,
    "default":null
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only string, integer, and boolean types are supported.

{
    "type":"object",
    "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{\"bar-key\": \"value\"}`. ",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only string, integer, and boolean types are supported. "
    }
}

Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`.

Nested Schema : additionalProperties

Type: object

The value of the tag. Only string, integer, and boolean types are supported.

Nested Schema : CreateContainerVolumeDetails

Type: object

Discriminator: volumeType

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

Show Source

• name(required): string
  Minimum Length: 1

  Maximum Length: 256

  The name of the volume. This must be unique within a single container instance.
• volumeType(required): string
  Default Value: oracle.doceng.json.BetterJsonNull@6b00ad9

  Allowed Values: [ "EMPTYDIR", "CONFIGFILE" ]

  The type of volume.

{
    "description":"A volume represents a directory with data that is accessible across multiple containers in a container instance. ",
    "discriminator":"volumeType",
    "required":[
        "name",
        "volumeType"
    ],
    "properties":{
        "name":{
            "description":"The name of the volume. This must be unique within a single container instance. ",
            "type":"string",
            "minLength":1,
            "maxLength":256
        },
        "volumeType":{
            "description":"The type of volume.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/ContainerVolumeType",
            "enum":[
                "EMPTYDIR",
                "CONFIGFILE"
            ],
            "default":null
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

The container instance was created. Container instance object is returned in response body.

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• opc-work-request-id: string
  Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

Body ()

Root Schema : ContainerInstance

Type: object

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.

Show Source

• availabilityDomain(required): string
  Minimum Length: 1

  Maximum Length: 255

  The availability domain to place the container instance.
• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  Pattern: ^\S+$

  The OCID of the compartment.
• containerCount(required): integer
  The number of containers on the container instance.
• containerRestartPolicy(required): string
  Allowed Values: [ "ALWAYS", "NEVER", "ON_FAILURE" ]

  The container restart policy is applied for all containers in container instance.
• containers(required): array containers
  The containers on the container instance.
• definedTags: object definedTags
  Additional Properties Allowed: additionalProperties

  Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`.
• displayName(required): string
  Minimum Length: 1

  Maximum Length: 255

  A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
• dnsConfig: object ContainerDnsConfig
  DNS settings for containers.
• faultDomain: string
  Minimum Length: 1

  Maximum Length: 255

  The fault domain to place the container instance.
• freeformTags: object freeformTags
  Additional Properties Allowed: additionalProperties

  Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
• gracefulShutdownTimeoutInSeconds: integer(int64)
  Minimum Value: 0

  Maximum Value: 3600

  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.
• id(required): string
  Minimum Length: 1

  Maximum Length: 255

  An OCID that cannot be changed.
• imagePullSecrets: array imagePullSecrets
  The image pulls secrets so you can access private registry to pull container images.
• lifecycleDetails: string
  A message that describes the current state of the container in more detail. Can be used to provide actionable information.
• lifecycleState(required): string
  Allowed Values: [ "CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED" ]

  The current state of the container instance.
• physicalShape: string
  The physical shape of the generic shape container instance. If CI is non-generic physical shape will be the same as shape.
• securityContext: object ContainerInstanceSecurityContext
  Discriminator: securityContextType

  Security context for all containers in a container instance.
• shape(required): 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(required): object ContainerInstanceShapeConfig
  The shape configuration for a container instance. The shape configuration determines the resources thats are available to the container instance and its containers.
• streamId: string
  Minimum Length: 1

  Maximum Length: 255

  Customer's streaming OCID which is used for receiving a message whenever container health check status changes.
• systemTags: object systemTags
  Additional Properties Allowed: additionalProperties

  Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`.
• timeCreated(required): string(date-time)
  The time the container instance was created, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
• timeUpdated: string(date-time)
  The time the container instance was updated, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
• vnics(required): array vnics
  The virtual networks available to the containers in the container instance.
• volumeCount: integer
  The number of volumes that are attached to the container instance.
• volumes: array volumes
  A volume is a directory with data that is accessible across multiple containers in a container instance.

{
    "description":"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. ",
    "type":"object",
    "x-obmcs-splat":{
        "resourceKind":"compute-container-instances",
        "ocidEntityType":"computecontainerinstance",
        "adLocality":"ad-local",
        "activeLifecycleStates":[
            "active",
            "inactive"
        ],
        "deletedLifecycleStates":[
            "deleted",
            "failed"
        ],
        "getOperationId":"GetContainerInstance",
        "listResourcesOperationId":"ListContainerInstances",
        "externalQuotaMappingService":"compute",
        "searchMetadata":{
            "resourceSchemaVersion":1,
            "resourceType":"ContainerInstance",
            "scope":"customer"
        },
        "workRequestDetails":{
            "workRequestEntityType":"computecontainerworkrequest",
            "workRequestGetOperationId":"GetWorkRequest",
            "successfulLifecycleStates":[
                "SUCCEEDED"
            ],
            "failedLifecycleStates":[
                "FAILED",
                "CANCELLED"
            ]
        }
    },
    "required":[
        "id",
        "displayName",
        "compartmentId",
        "availabilityDomain",
        "lifecycleState",
        "timeCreated",
        "shape",
        "shapeConfig",
        "vnics",
        "containers",
        "containerCount",
        "containerRestartPolicy"
    ],
    "properties":{
        "id":{
            "description":"An OCID that cannot be changed.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "displayName":{
            "description":"A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "compartmentId":{
            "description":"The OCID of the compartment.",
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "pattern":"^\\S+$"
        },
        "freeformTags":{
            "description":"Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` ",
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "definedTags":{
            "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`. ",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{\"bar-key\": \"value\"}`. ",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only string, integer, and boolean types are supported. "
                }
            }
        },
        "systemTags":{
            "description":"Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`. ",
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "description":"Key-value pair representing system tags' keys and values scoped to a namespace. Example: `{\"bar-key\": \"value\"}` ",
                "additionalProperties":{
                    "type":"object",
                    "description":"The value of the tag. Only string, integer, and boolean types are supported. "
                }
            }
        },
        "availabilityDomain":{
            "description":"The availability domain to place the container instance.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "faultDomain":{
            "description":"The fault domain to place the container instance.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "lifecycleState":{
            "description":"The current state of the container instance.",
            "type":"string",
            "enum":[
                "CREATING",
                "UPDATING",
                "ACTIVE",
                "INACTIVE",
                "DELETING",
                "DELETED",
                "FAILED"
            ]
        },
        "lifecycleDetails":{
            "description":"A message that describes the current state of the container in more detail. Can be used to provide actionable information. ",
            "type":"string"
        },
        "volumes":{
            "description":"A volume is a directory with data that is accessible across multiple containers in a container instance. ",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ContainerVolume"
            }
        },
        "volumeCount":{
            "description":"The number of volumes that are attached to the container instance.",
            "type":"integer"
        },
        "containers":{
            "description":"The containers on the container instance.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ContainerInstanceContainer"
            }
        },
        "containerCount":{
            "description":"The number of containers on the container instance.",
            "type":"integer"
        },
        "timeCreated":{
            "description":"The time the container instance was created, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).",
            "type":"string",
            "format":"date-time"
        },
        "timeUpdated":{
            "description":"The time the container instance was updated, in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).",
            "type":"string",
            "format":"date-time"
        },
        "shape":{
            "description":"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.",
            "type":"string"
        },
        "physicalShape":{
            "description":"The physical shape of the generic shape container instance. If CI is non-generic physical shape will be the same as shape.",
            "type":"string"
        },
        "shapeConfig":{
            "$ref":"#/definitions/ContainerInstanceShapeConfig"
        },
        "vnics":{
            "description":"The virtual networks available to the containers in the container instance.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ContainerVnic"
            }
        },
        "dnsConfig":{
            "$ref":"#/definitions/ContainerDnsConfig"
        },
        "gracefulShutdownTimeoutInSeconds":{
            "description":"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.",
            "type":"integer",
            "format":"int64",
            "minimum":0,
            "maximum":3600
        },
        "imagePullSecrets":{
            "description":"The image pulls secrets so you can access private registry to pull container images.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ImagePullSecret"
            }
        },
        "containerRestartPolicy":{
            "description":"The container restart policy is applied for all containers in container instance.",
            "type":"string",
            "enum":[
                "ALWAYS",
                "NEVER",
                "ON_FAILURE"
            ]
        },
        "streamId":{
            "description":"Customer's streaming OCID which is used for receiving a message whenever container health check status changes. ",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "securityContext":{
            "$ref":"#/definitions/ContainerInstanceSecurityContext"
        }
    }
}

Nested Schema : containers

Type: array

The containers on the container instance.

Show Source

• Array of: object ContainerInstanceContainer
  A container on a container instance.

{
    "description":"The containers on the container instance.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ContainerInstanceContainer"
    }
}

Nested Schema : definedTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`.

{
    "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`. ",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{\"bar-key\": \"value\"}`. ",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only string, integer, and boolean types are supported. "
        }
    }
}

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

Nested Schema : ContainerDnsConfig

Type: object

DNS settings for containers.

Show Source

• nameservers: array nameservers
  IP address of the name server..
• options: array options
  Options allows certain internal resolver variables to be modified.
• searches: array searches
  Search list for hostname lookup.

{
    "description":"DNS settings for containers.",
    "type":"object",
    "properties":{
        "nameservers":{
            "description":"IP address of the name server..",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "searches":{
            "description":"Search list for hostname lookup.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "options":{
            "description":"Options allows certain internal resolver variables to be modified.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : freeformTags

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}` ",
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

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

Nested Schema : imagePullSecrets

Type: array

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

Show Source

• Array of: object ImagePullSecret
  Discriminator: secretType

  The image pull secrets for accessing private registry to pull images for containers

{
    "description":"The image pulls secrets so you can access private registry to pull container images.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ImagePullSecret"
    }
}

Nested Schema : ContainerInstanceSecurityContext

Type: object

Discriminator: securityContextType

Security context for all containers in a container instance.

Show Source

• securityContextType: string
  Default Value: LINUX

  Allowed Values: [ "LINUX" ]

  The type of security context

{
    "description":"Security context for all containers in a container instance.",
    "discriminator":"securityContextType",
    "properties":{
        "securityContextType":{
            "description":"The type of security context",
            "type":"string",
            "enum":[
                "LINUX"
            ],
            "default":"LINUX"
        }
    },
    "type":"object"
}

Nested Schema : ContainerInstanceShapeConfig

Type: object

The shape configuration for a container instance. The shape configuration determines the resources thats are available to the container instance and its containers.

Show Source

• memoryInGBs(required): number(float)
  Minimum Value: 0

  The total amount of memory available to the container instance, in gigabytes.
• networkingBandwidthInGbps(required): number(float)
  Minimum Value: 0

  The networking bandwidth available to the container instance, in gigabits per second.
• ocpus(required): number(float)
  Minimum Value: 0

  The total number of OCPUs available to the container instance.
• processorDescription(required): string
  Minimum Length: 1

  Maximum Length: 255

  A short description of the container instance's processor (CPU).

{
    "description":"The shape configuration for a container instance. The shape configuration determines the resources thats are available to the container instance and its containers. ",
    "type":"object",
    "required":[
        "ocpus",
        "memoryInGBs",
        "processorDescription",
        "networkingBandwidthInGbps"
    ],
    "properties":{
        "ocpus":{
            "description":"The total number of OCPUs available to the container instance. ",
            "x-default-description":"If you do not provide one, this is calculated from container resource configuration.",
            "format":"float",
            "minimum":0,
            "type":"number"
        },
        "memoryInGBs":{
            "description":"The total amount of memory available to the container instance, in gigabytes. ",
            "format":"float",
            "minimum":0,
            "type":"number"
        },
        "processorDescription":{
            "description":"A short description of the container instance's processor (CPU). ",
            "maxLength":255,
            "minLength":1,
            "type":"string"
        },
        "networkingBandwidthInGbps":{
            "description":"The networking bandwidth available to the container instance, in gigabits per second. ",
            "format":"float",
            "minimum":0,
            "type":"number"
        }
    }
}

Nested Schema : systemTags

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

  Key-value pair representing system tags' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`

{
    "description":"Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`. ",
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "description":"Key-value pair representing system tags' keys and values scoped to a namespace. Example: `{\"bar-key\": \"value\"}` ",
        "additionalProperties":{
            "type":"object",
            "description":"The value of the tag. Only string, integer, and boolean types are supported. "
        }
    }
}

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

Nested Schema : vnics

Type: array

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

Show Source

• Array of: object ContainerVnic
  An interface to a virtual network available to containers on a container instance.

{
    "description":"The virtual networks available to the containers in the container instance.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ContainerVnic"
    }
}

Nested Schema : volumes

Type: array

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

Show Source

• Array of: object ContainerVolume
  Discriminator: volumeType

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

{
    "description":"A volume is a directory with data that is accessible across multiple containers in a container instance. ",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ContainerVolume"
    }
}

Nested Schema : ContainerInstanceContainer

Type: object

A container on a container instance.

Show Source

• containerId(required): string
  The OCID of the container.
• displayName: string
  Display name for the Container.

{
    "description":"A container on a container instance. ",
    "type":"object",
    "required":[
        "containerId"
    ],
    "properties":{
        "containerId":{
            "description":"The OCID of the container.",
            "type":"string"
        },
        "displayName":{
            "description":"Display name for the Container.",
            "type":"string"
        }
    }
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only string, integer, and boolean types are supported.

{
    "type":"object",
    "description":"Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{\"bar-key\": \"value\"}`. ",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only string, integer, and boolean types are supported. "
    }
}

Key-value pair representing predefined tags' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`.

Nested Schema : additionalProperties

Type: object

The value of the tag. Only string, integer, and boolean types are supported.

Nested Schema : nameservers

Type: array

IP address of the name server..

Show Source

• Array of: string

{
    "description":"IP address of the name server..",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : options

Type: array

Options allows certain internal resolver variables to be modified.

Show Source

• Array of: string

{
    "description":"Options allows certain internal resolver variables to be modified.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : searches

Type: array

Search list for hostname lookup.

Show Source

• Array of: string

{
    "description":"Search list for hostname lookup.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : ImagePullSecret

Type: object

Discriminator: secretType

The image pull secrets for accessing private registry to pull images for containers

Show Source

• registryEndpoint(required): string
  The registry endpoint of the container image.
• secretType(required): string
  Allowed Values: [ "BASIC", "VAULT" ]

  The type of ImagePullSecret.

{
    "description":"The image pull secrets for accessing private registry to pull images for containers ",
    "type":"object",
    "discriminator":"secretType",
    "required":[
        "secretType",
        "registryEndpoint"
    ],
    "properties":{
        "secretType":{
            "description":"The type of ImagePullSecret.",
            "type":"string",
            "enum":[
                "BASIC",
                "VAULT"
            ]
        },
        "registryEndpoint":{
            "description":"The registry endpoint of the container image.",
            "type":"string"
        }
    }
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  The value of the tag. Only string, integer, and boolean types are supported.

{
    "type":"object",
    "description":"Key-value pair representing system tags' keys and values scoped to a namespace. Example: `{\"bar-key\": \"value\"}` ",
    "additionalProperties":{
        "type":"object",
        "description":"The value of the tag. Only string, integer, and boolean types are supported. "
    }
}

Key-value pair representing system tags' keys and values scoped to a namespace. Example: `{"bar-key": "value"}`

Nested Schema : additionalProperties

Type: object

The value of the tag. Only string, integer, and boolean types are supported.

Nested Schema : ContainerVnic

Type: object

An interface to a virtual network available to containers on a container instance.

Show Source

• vnicId: string
  The identifier of the virtual network interface card (VNIC) over which the containers accessing this network can communicate with the larger virtual cloud network.

{
    "description":"An interface to a virtual network available to containers on a container instance. ",
    "type":"object",
    "properties":{
        "vnicId":{
            "description":"The identifier of the virtual network interface card (VNIC) over which the containers accessing this network can communicate with the larger virtual cloud network. ",
            "type":"string"
        }
    }
}

Nested Schema : ContainerVolume

Type: object

Discriminator: volumeType

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

Show Source

• name(required): string
  Minimum Length: 1

  Maximum Length: 256

  The name of the volume. This must be unique within a single container instance.
• volumeType(required): string
  Allowed Values: [ "EMPTYDIR", "CONFIGFILE" ]

  The type of volume.

{
    "description":"A volume represents a directory with data that is accessible across multiple containers in a container instance. ",
    "discriminator":"volumeType",
    "required":[
        "name",
        "volumeType"
    ],
    "properties":{
        "name":{
            "description":"The name of the volume. This must be unique within a single container instance. ",
            "type":"string",
            "minLength":1,
            "maxLength":256
        },
        "volumeType":{
            "description":"The type of volume.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/ContainerVolumeType",
            "enum":[
                "EMPTYDIR",
                "CONFIGFILE"
            ]
        }
    },
    "type":"object"
}

400 Response

Bad Request

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

401 Response

Unauthorized

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

404 Response

Not Found

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

409 Response

Conflict

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

429 Response

Too Many Requests

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

500 Response

Internal Server Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Default Response

Unknown Error

Headers

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you must contact Oracle about a particular request, then provide the request identifier.

Body ()

Root Schema : Error

Type: object

The properties that define an error.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).
• message(required): string
  A human-readable error string.

{
    "description":"The properties that define an error.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing. See [API Errors](https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "type":"object"
}

Back to Top