GET /docker/api/v2/containers
Liste todos os containers

GET /docker/api/v2/compute_resources/:compute_resource_id/containers
List all containers on a compute resource

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

compute_resource_id
opcional

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

search
opcional

filtrar resultados

Validations:

  • Must be a String

order
opcional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
opcional

paginar resultados

Validations:

  • Must be a String

per_page
opcional

número de entradas por requisições

Validations:

  • Must be a String


GET /docker/api/v2/containers/:id
Exibir um container

GET /docker/api/v2/compute_resources/:compute_resource_id/containers/:id
Show container on a compute resource

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

id
requerido

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

compute_resource_id
opcional

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /docker/api/v2/containers
Criar um Container

POST /docker/api/v2/compute_resources/:compute_resource_id/containers
Create container on a compute resource

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

container
requerido

Validations:

  • Must be a Hash

container[name]
opcional , nulo permitido

Validations:

  • Must be a String

container[location_ids]
opcional , nulo permitido

SUBSTITUIR localizações dadas com ids

Validations:

  • Must be an array of any type

container[organization_ids]
opcional , nulo permitido

SUBSTITUIR organizações dadas com ids

Validations:

  • Must be an array of any type

container[compute_resource_id]
requerido

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

container[registry_id]
opcional , nulo permitido

Registry this container will have to use to get the image

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

container[repository_name]
requerido

Name of the repository to use to create the container. e.g. centos

Validations:

  • Must be a String

container[tag]
requerido

Tag to use to create the container. e.g. latest

Validations:

  • Must be a String

container[tty]
opcional , nulo permitido

Validations:

  • Must be one of: true, false, 1, 0

container[entrypoint]
opcional , nulo permitido

Validations:

  • Must be a String

container[command]
requerido

Validations:

  • Must be a String

container[memory]
opcional , nulo permitido

Validations:

  • Must be a String

container[cpu_shares]
opcional , nulo permitido

Validations:

  • Must be a number.

container[cpu_set]
opcional , nulo permitido

Validations:

  • Must be a String

container[environment_variables]
opcional , nulo permitido

Optional array of environment variables hashes. e.g. 'environment_variables': [{'name' => 'example', 'value' => '123'}]

Validations:

  • Must be an array of any type

container[attach_stdout]
opcional , nulo permitido

Validations:

  • Must be one of: true, false, 1, 0

container[attach_stdin]
opcional , nulo permitido

Validations:

  • Must be one of: true, false, 1, 0

container[attach_stderr]
opcional , nulo permitido

Validations:

  • Must be one of: true, false, 1, 0

container[capsule_id]
opcional , nulo permitido

The capsule this container will have to use to get the image. Relevant for images retrieved from katello registry.

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


DELETE /docker/api/v2/containers/:id
Remover um container

DELETE /docker/api/v2/compute_resources/:compute_resource_id/containers/:id
Delete container on a compute resource

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

id
requerido

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

compute_resource_id
opcional

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


GET /docker/api/v2/containers/:id/logs
Exibir logs de container

GET /docker/api/v2/compute_resources/:compute_resource_id/containers/:id/logs
Show logs from a container on a compute resource

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

id
requerido

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

compute_resource_id
opcional

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

stdout
opcional

Validations:

  • Must be one of: true, false, 1, 0

stderr
opcional

Validations:

  • Must be one of: true, false, 1, 0

tail
opcional

Número de linhas a finalizar. Default: 100

Validations:

  • Must be a Integer


PUT /docker/api/v2/containers/:id/power
Executar uma operação power no container

PUT /docker/api/v2/compute_resources/:compute_resource_id/containers/:id/power
Run power operation on a container on a compute resource

Parâmentros

Nome parâmetro Descrição
location_id
opcional

Escopo de localizações

Validations:

  • Must be a Integer

organization_id
opcional

Escopo de organização

Validations:

  • Must be a Integer

id
requerido

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

compute_resource_id
opcional

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

power_action
requerido

ação, ações válidas são (start), (stop), (status)

Validations:

  • Must be a String