Jump to

• Request
• Response

Get a list of Containers in a compartment

get

/20210415/containers

Returns a list of containers in a compartment.

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.
• containerInstanceId: string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container instance.
• 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

The list was retrieved.

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

Type: object

A list of containers.

Show Source

• items(required): array items
  Minimum Number of Items: 1

  Maximum Number of Items: 10

  List of containers.

{
    "type":"object",
    "description":"A list of containers. ",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "description":"List of containers.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/ContainerSummary"
            },
            "minItems":1,
            "maxItems":10
        }
    }
}

Nested Schema : items

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 10

List of containers.

Show Source

• Array of: object ContainerSummary
  Summary information about a container.

{
    "description":"List of containers.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ContainerSummary"
    },
    "minItems":1,
    "maxItems":10
}

Nested Schema : ContainerSummary

Type: object

Summary information about a container.

Show Source

• availabilityDomain(required): string
  Minimum Length: 1

  Maximum Length: 255

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

  Maximum Length: 255

  The compartment [OCID](/iaas/Content/General/Concepts/identifiers.htm).
• containerInstanceId(required): string
  Minimum Length: 1

  Maximum Length: 255

  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container instance on which the container is running.
• 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 that hosts the container 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"}`
• id(required): string
  Minimum Length: 1

  Maximum Length: 255

  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container.
• 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.
• isResourcePrincipalDisabled: boolean
  Determines whether the container will have access to the container instance resource principal. This method utilizes resource principal version 2.2. For information on how to use the exposed resource principal elements, see https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm#sdk_authentication_methods_resource_principal.
• 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
  The current state of the container.
• resourceConfig: object ContainerResourceConfig
  The resource configuration for a container. The resource configuration determines the amount of resources allocated to the container and the maximum allowed resources for a container.
• securityContext: object SecurityContext
  Discriminator: securityContextType

  Security context for container.
• 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 the container was created in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).
• timeUpdated: string(date-time)
  The time the container was updated in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).

{
    "description":"Summary information about a container. ",
    "type":"object",
    "required":[
        "id",
        "displayName",
        "compartmentId",
        "availabilityDomain",
        "lifecycleState",
        "timeCreated",
        "containerInstanceId",
        "imageUrl"
    ],
    "properties":{
        "id":{
            "description":"The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container.",
            "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 compartment [OCID](/iaas/Content/General/Concepts/identifiers.htm).",
            "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 that hosts this container runs.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "faultDomain":{
            "description":"The fault domain where the container instance that hosts the container runs.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "lifecycleState":{
            "description":"The current state of the container.",
            "type":"string",
            "x-obmcs-enumref":"#/definitions/Container/lifecycleState"
        },
        "lifecycleDetails":{
            "description":"A message that describes the current state of the container in more detail. Can be used to provide actionable information. ",
            "type":"string"
        },
        "timeCreated":{
            "description":"The time the the container 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 was updated in the format defined by [RFC 3339](https://tools.ietf.org/rfc/rfc3339).",
            "type":"string",
            "format":"date-time"
        },
        "containerInstanceId":{
            "description":"The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the container instance on which the container is running.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "resourceConfig":{
            "$ref":"#/definitions/ContainerResourceConfig"
        },
        "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
        },
        "isResourcePrincipalDisabled":{
            "description":"Determines whether the container will have access to the container instance resource principal.  This method utilizes resource principal version 2.2. For information on how to use the exposed resource principal elements, see https://docs.oracle.com/en-us/iaas/Content/API/Concepts/sdk_authentication_methods.htm#sdk_authentication_methods_resource_principal. ",
            "type":"boolean"
        },
        "securityContext":{
            "$ref":"#/definitions/SecurityContext"
        }
    }
}

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

Type: object

The resource configuration for a container. The resource configuration determines the amount of resources allocated to the container and the maximum allowed resources for a container.

Show Source

• memoryLimitInGBs: number(float)
  Minimum Value: 0

  Default Value: oracle.doceng.json.BetterJsonNull@6f49d153

  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@4339baec

  The maximum amount of CPUs that can be consumed by the container's process. If you do not set a value, then the process may use all available CPU resources on the container 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.

{
    "description":"The resource configuration for a container. The resource configuration determines the amount of resources allocated to the container and the maximum allowed resources for a 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 may use all available CPU resources on the container 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. ",
            "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 : SecurityContext

Type: object

Discriminator: securityContextType

Security context for container.

Show Source

• securityContextType: string
  Default Value: LINUX

  Allowed Values: [ "LINUX" ]

  The type of security context

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

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