v1

Container Groups

Inspect a container group.

This endpoint retrieves detailed information about a container group with a given name (corresponding IBM Containers command: cf ic group inspect GROUP).

get/containers/groups/{name_or_id}

Path parameters

name_or_idstring required

The name or unique ID of the container group that you want to inspect. Run cf ic group list or call the GET /containers/groups endpoint to retrieve a list of container groups in your space.

Headers

X-Auth-Tokenstring required

The Bluemix JSON web token that you receive when logging into Bluemix. Run cf oauth-token to retrieve your access token.

X-Auth-Project-Idstring required

The unique ID of your organization space where you want to create or work with your containers. Run cf space <space_name> --guid, where <space_name> is the name of your space, to retrieve your space ID.

Response

OK. A detailed list of information about a container group is retrieved.

Anti-affinitystring

If set to true the container instances in the group are spread across separate physical compute nodes, which reduces the likelihood of containers crashing due to hardware failures. If set to false, the container instances in the group share the same physical compute node.

Autorecoverystring

Can be either true or false. If set to true, the Autorecovery mode is enabled for your container group. In case a container instance crashes or stops, this instance is removed and a new one is automatically recreated. If set to false, the Autorecovery mode is disabled. In case a container instances crashes or stops, it is not automatically recreated by IBM Containers.

AvailabilityZonestring

Current IBM Containers availability zone on Openstack.

Cmdstring[]

The Docker command that was specified to be run when the container instances are started.

Creation_timestring

Timestamp when the container group was created.

Envstring[]

The list of environmental variables that were defined for the container group. Each environment variable consists of a unique key and a value.

Idstring

Unique identifier representing a specific container group.

Imagestring

The unique ID of the container image your container group instances are based on.

ImageNamestring

The full path to the container image in your private Bluemix repository.

Memoryinteger

The size of each container instance that runs in the container group in MegaByte.

Namestring

The name of the container group.

Portinteger

The public port that has been exposed. If you specified a route, your container group is accessible from the Internet.

Routesstring[]

The public route that is mapped to the container group. When you expose a public port, you can use the route to access your container group from the Internet.

Statusstring

The current status of the container group. The container group status is a composite of ACTION and STATUS:<br><br> ACTIONS = (CREATE, DELETE, UPDATE, ROLLBACK, SUSPEND, RESUME, ADOPT, SNAPSHOT, CHECK, RESTORE)<br><br> STATUSES = (IN_PROGRESS, FAILED, COMPLETE)

UpdatedTimestring

Timestamp when the container group was updated. If the container group was not updated before, null is returned.

Volumesstring[]

List of volumes to be associated with the container, in the format of volume name:path:mode where mode can be ro or rw.