Skip to content

Latest commit

 

History

History
242 lines (158 loc) · 6.4 KB

ExecApi.md

File metadata and controls

242 lines (158 loc) · 6.4 KB
Raw

Piurafunk\Docker\ExecApi

All URIs are relative to https://localhost/v1.40

Method HTTP request Description
containerExec POST /containers/{id}/exec Create an exec instance
execInspect GET /exec/{id}/json Inspect an exec instance
execResize POST /exec/{id}/resize Resize an exec instance
execStart POST /exec/{id}/start Start an exec instance

containerExec

\Piurafunk\Docker\Model\IdResponse containerExec($id, $execConfig)

Create an exec instance

Run a command inside a running container.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$apiInstance = new Piurafunk\Docker\Api\ExecApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = 'id_example'; // string | ID or name of container
$execConfig = new \Piurafunk\Docker\Model\InlineObject(); // \Piurafunk\Docker\Model\InlineObject | 

try {
    $result = $apiInstance->containerExec($id, $execConfig);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExecApi->containerExec: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string ID or name of container
execConfig \Piurafunk\Docker\Model\InlineObject

Return type

\Piurafunk\Docker\Model\IdResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

execInspect

\Piurafunk\Docker\Model\ExecInspectResponse execInspect($id)

Inspect an exec instance

Return low-level information about an exec instance.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$apiInstance = new Piurafunk\Docker\Api\ExecApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = 'id_example'; // string | Exec instance ID

try {
    $result = $apiInstance->execInspect($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ExecApi->execInspect: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string Exec instance ID

Return type

\Piurafunk\Docker\Model\ExecInspectResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

execResize

execResize($id, $h, $w)

Resize an exec instance

Resize the TTY session used by an exec instance. This endpoint only works if tty was specified as part of creating and starting the exec instance.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$apiInstance = new Piurafunk\Docker\Api\ExecApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = 'id_example'; // string | Exec instance ID
$h = 56; // int | Height of the TTY session in characters
$w = 56; // int | Width of the TTY session in characters

try {
    $apiInstance->execResize($id, $h, $w);
} catch (Exception $e) {
    echo 'Exception when calling ExecApi->execResize: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string Exec instance ID
h int Height of the TTY session in characters [optional]
w int Width of the TTY session in characters [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/plain

[Back to top] [Back to API list] [Back to Model list] [Back to README]

execStart

execStart($id, $execStartConfig)

Start an exec instance

Starts a previously set up exec instance. If detach is true, this endpoint returns immediately after starting the command. Otherwise, it sets up an interactive session with the command.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


$apiInstance = new Piurafunk\Docker\Api\ExecApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$id = 'id_example'; // string | Exec instance ID
$execStartConfig = new \Piurafunk\Docker\Model\InlineObject1(); // \Piurafunk\Docker\Model\InlineObject1 | 

try {
    $apiInstance->execStart($id, $execStartConfig);
} catch (Exception $e) {
    echo 'Exception when calling ExecApi->execStart: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id string Exec instance ID
execStartConfig \Piurafunk\Docker\Model\InlineObject1 [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.docker.raw-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]