GET /docker/api/v2/containers
すべてのコンテナーの一覧表示

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

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

compute_resource_id
任意

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
任意

結果のフィルター

Validations:

  • Must be a String

order
任意

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
任意

結果のページネーション

Validations:

  • Must be a String

per_page
任意

要求ごとのエントリー数

Validations:

  • Must be a String


GET /docker/api/v2/containers/:id
コンテナーの表示

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

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

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
任意

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
コンテナーの作成

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

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

container
必須

Validations:

  • Must be a Hash

container[name]
任意 , nil可

Validations:

  • Must be a String

container[location_ids]
任意 , nil可

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type

container[organization_ids]
任意 , nil可

組織を指定された ID に置き換えます。

Validations:

  • Must be an array of any type

container[compute_resource_id]
必須

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]
任意 , nil可

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]
必須

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

Validations:

  • Must be a String

container[tag]
必須

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

Validations:

  • Must be a String

container[tty]
任意 , nil可

Validations:

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

container[entrypoint]
任意 , nil可

Validations:

  • Must be a String

container[command]
必須

Validations:

  • Must be a String

container[memory]
任意 , nil可

Validations:

  • Must be a String

container[cpu_shares]
任意 , nil可

Validations:

  • Must be a number.

container[cpu_set]
任意 , nil可

Validations:

  • Must be a String

container[environment_variables]
任意 , nil可

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]
任意 , nil可

Validations:

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

container[attach_stdin]
任意 , nil可

Validations:

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

container[attach_stderr]
任意 , nil可

Validations:

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

container[capsule_id]
任意 , nil可

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
コンテナーの削除

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

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

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
任意

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
コンテナーログの表示

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

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

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
任意

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
任意

Validations:

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

stderr
任意

Validations:

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

tail
任意

末尾の表示する行の数。デフォルト: 100

Validations:

  • Must be a Integer


PUT /docker/api/v2/containers/:id/power
コンテナーでパワー操作を実行

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

パラメーター

パラメーター名 記述
location_id
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

Validations:

  • Must be a Integer

id
必須

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
任意

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
必須

パワーアクション。有効なアクションは (start)、(stop)、(status) です。

Validations:

  • Must be a String