Jump to

• Request
• Response

Get ContainerInstance

get

/20210415/containerInstances/{container_instance_id}

Gets information about the specified container instance.

Request

Supported Media Types

• application/json

Path Parameters

• containerInstanceId(required): string
  Pattern: ^\S+$

  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container instance.

Header Parameters

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. Provide this request OCID if you need to contact Oracle about this request.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Retrieves the container instance with the given ID.

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.

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"
}

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