Jump to

• Request
• Response

Gets a list of all ContainerInstances in a compartment

get

/20210415/containerInstances

Returns a list of container instances.

Request

Supported Media Types

• application/json

Query Parameters

• availabilityDomain: string
  The availability domain of the pod shape.
• compartmentId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The OCID of the compartment.
• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  The displayName of a resource.

  Default Value: none
• lifecycleState: string
  A filter to only return resources that match the given lifecycle state.
• limit: integer
  Minimum Value: 1

  Maximum Value: 1000

  For list pagination. The maximum number of results per page, or items to return in a paginated List call. 1 is the minimum, 1000 is the maximum.

  Default Value: 100
• page: string
  Minimum Length: 1

  Maximum Length: 512

  For list pagination. The value of the opc-next-page response header from the previous List call.

  Default Value: 0
• sortBy: string
  The optional field to sort the results by.

  Allowed Values: [ "TIMECREATED", "NAME" ]
• sortOrder: string
  The sort order to use, either ascending (ASC) or descending (DESC).

  Default Value: ASC

  Allowed Values: [ "ASC", "DESC" ]

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

A page of ContainerInstanceSummary objects.

Headers

• opc-next-page: string
  Pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
• 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 : ContainerInstanceCollection

Type: object

Summary information about a list of container instances.

Show Source

• items(required): array items
  List of container instances.

{
    "type":"object",
    "description":"Summary information about a list of container instances.",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of container instances.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ContainerInstanceSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

List of container instances.

Show Source

• Array of: object ContainerInstanceSummary
  A set of details about a single container instance returned by list APIs.

{
    "description":"List of container instances.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ContainerInstanceSummary"
    }
}

Nested Schema : ContainerInstanceSummary

Type: object

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

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 OCID of the compartment to create the container instance in.
• containerCount(required): integer
  The number of containers in the container instance.
• containerRestartPolicy(required): string
  Container Restart Policy
• 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.
• 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

  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

  OCID that cannot be changed.
• lifecycleDetails: string
  A message that describes the current state of the container instance in more detail. Can be used to provide actionable information.
• lifecycleState(required): string
  The current state of the container instance.
• 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 resources available to the 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.
• 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 RFC3339.
• timeUpdated: string(date-time)
  The time the container instance was updated, in the format defined by RFC3339.
• volumeCount: integer
  The number of volumes that are attached to the container instance.

{
    "description":"A set of details about a single container instance returned by list APIs. ",
    "type":"object",
    "required":[
        "id",
        "displayName",
        "compartmentId",
        "availabilityDomain",
        "lifecycleState",
        "timeCreated",
        "shape",
        "shapeConfig",
        "containerCount",
        "containerRestartPolicy"
    ],
    "properties":{
        "id":{
            "description":"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 to create the container instance in.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "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 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
        },
        "lifecycleState":{
            "description":"The current state of the container instance.",
            "type":"string",
            "x-obmcs-enumref":"#/definitions/ContainerInstance/lifecycleState"
        },
        "lifecycleDetails":{
            "description":"A message that describes the current state of the container instance in more detail. Can be used to provide actionable information. ",
            "type":"string"
        },
        "timeCreated":{
            "description":"The time the container instance was created, in the format defined by RFC3339.",
            "type":"string",
            "format":"date-time"
        },
        "timeUpdated":{
            "description":"The time the container instance was updated, in the format defined by RFC3339.",
            "type":"string",
            "format":"date-time"
        },
        "shape":{
            "description":"The shape of the container instance. The shape determines the resources available to the container instance.",
            "type":"string"
        },
        "shapeConfig":{
            "$ref":"#/definitions/ContainerInstanceShapeConfig"
        },
        "containerCount":{
            "description":"The number of containers in the container instance.",
            "type":"integer"
        },
        "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
        },
        "volumeCount":{
            "description":"The number of volumes that are attached to the container instance.",
            "type":"integer"
        },
        "containerRestartPolicy":{
            "description":"Container Restart Policy",
            "type":"string",
            "x-obmcs-enumref":"#/definitions/ContainerInstance/containerRestartPolicy"
        },
        "securityContext":{
            "$ref":"#/definitions/ContainerInstanceSecurityContext"
        }
    }
}

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

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