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

GET /docker/api/v2/compute_resources/:compute_resource_id/containers
コンピュートリソースのすべてのコンテナーを一覧表示

Params

Param Name Description
compute_resource_id
Optional

Value:

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

search
Optional

結果をフィルタ


Value:

Must be String

order
Optional

結果をソート


Value:

Must be String

page
Optional

結果をページ分割


Value:

Must be String

per_page
Optional

リクエストあたりのエントリ数


Value:

Must be String


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

GET /docker/api/v2/compute_resources/:compute_resource_id/containers/:id
コンピュートリソースのコンテナーを表示

Params

Param Name Description
id
Required

Value:

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
Optional

Value:

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
コンピュートリソースにコンテナーを作成

Params

Param Name Description
container
Required

Value:

Must be a Hash

container[name]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be String

container[compute_resource_id]
Required

Value:

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]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Registry this container will have to

use to get the image

Value:

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]
Required

Name of the repository to use

to create the container. e.g: centos

Value:

Must be String

container[tag]
Required

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


Value:

Must be String

container[tty]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be ‘true’ or ‘false’

container[entrypoint]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be String

container[command]
Required

Value:

Must be String

container[memory]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be String

container[cpu_shares]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be a number.

container[cpu_set]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be String

container[environment_variables]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be Hash

container[attach_stdout]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be ‘true’ or ‘false’

container[attach_stdin]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be ‘true’ or ‘false’

container[attach_stderr]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

Value:

Must be ‘true’ or ‘false’

container[capsule_id]
Optional , <span class="translation_missing" title="translation missing: ja.apipie.nil_allowed">Nil Allowed</span>

The capsule this container will have to use

to get the image. Relevant for images
retrieved from katello registry.

Value:

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
コンピュートリソースのコンテナーを削除

Params

Param Name Description
id
Required

Value:

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
Optional

Value:

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
コンピューターリソースのコンテナーからログを表示

Params

Param Name Description
id
Required

Value:

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
Optional

Value:

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

stdout
Optional

Value:

Must be ‘true’ or ‘false’

stderr
Optional

Value:

Must be ‘true’ or ‘false’

tail
Optional

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


Value:

Must be Fixnum


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

PUT /docker/api/v2/compute_resources/:compute_resource_id/containers/:id/power
コンピュートリソースのコンテナーでパワー操作を実行

Params

Param Name Description
id
Required

Value:

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
Optional

Value:

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
Required

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


Value:

Must be String