Skip to content

Latest commit

 

History

History
404 lines (280 loc) · 11.3 KB

CloudInstanceApi.md

File metadata and controls

404 lines (280 loc) · 11.3 KB
Raw

TeamCityClient\CloudInstanceApi

All URIs are relative to https://vs-szp-ds01.otr.ru:8111

Method HTTP request Description
serveImage GET /app/rest/cloud/images/{imageLocator}
serveImages GET /app/rest/cloud/images
serveInstance GET /app/rest/cloud/instances/{instanceLocator}
serveInstances GET /app/rest/cloud/instances
serveProfile GET /app/rest/cloud/profiles/{profileLocator}
serveProfiles GET /app/rest/cloud/profiles
startInstance POST /app/rest/cloud/instances
stopInstance DELETE /app/rest/cloud/instances/{instanceLocator}

serveImage

\TeamCityClient\Model\CloudImage serveImage($image_locator, $fields)

Example

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

$apiInstance = new TeamCityClient\Api\CloudInstanceApi(
    // 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()
);
$image_locator = "image_locator_example"; // string | 
$fields = "fields_example"; // string | 

try {
    $result = $apiInstance->serveImage($image_locator, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudInstanceApi->serveImage: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
image_locator string
fields string [optional]

Return type

\TeamCityClient\Model\CloudImage

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

serveImages

\TeamCityClient\Model\CloudImages serveImages($locator, $fields)

Example

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

$apiInstance = new TeamCityClient\Api\CloudInstanceApi(
    // 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()
);
$locator = "locator_example"; // string | 
$fields = "fields_example"; // string | 

try {
    $result = $apiInstance->serveImages($locator, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudInstanceApi->serveImages: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
locator string [optional]
fields string [optional]

Return type

\TeamCityClient\Model\CloudImages

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

serveInstance

\TeamCityClient\Model\CloudInstance serveInstance($instance_locator, $fields)

Example

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

$apiInstance = new TeamCityClient\Api\CloudInstanceApi(
    // 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()
);
$instance_locator = "instance_locator_example"; // string | 
$fields = "fields_example"; // string | 

try {
    $result = $apiInstance->serveInstance($instance_locator, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudInstanceApi->serveInstance: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
instance_locator string
fields string [optional]

Return type

\TeamCityClient\Model\CloudInstance

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

serveInstances

\TeamCityClient\Model\CloudInstances serveInstances($locator, $fields)

Example

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

$apiInstance = new TeamCityClient\Api\CloudInstanceApi(
    // 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()
);
$locator = "locator_example"; // string | 
$fields = "fields_example"; // string | 

try {
    $result = $apiInstance->serveInstances($locator, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudInstanceApi->serveInstances: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
locator string [optional]
fields string [optional]

Return type

\TeamCityClient\Model\CloudInstances

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

serveProfile

\TeamCityClient\Model\CloudProfile serveProfile($profile_locator, $fields)

Example

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

$apiInstance = new TeamCityClient\Api\CloudInstanceApi(
    // 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()
);
$profile_locator = "profile_locator_example"; // string | 
$fields = "fields_example"; // string | 

try {
    $result = $apiInstance->serveProfile($profile_locator, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudInstanceApi->serveProfile: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
profile_locator string
fields string [optional]

Return type

\TeamCityClient\Model\CloudProfile

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

serveProfiles

\TeamCityClient\Model\CloudProfiles serveProfiles($locator, $fields)

Example

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

$apiInstance = new TeamCityClient\Api\CloudInstanceApi(
    // 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()
);
$locator = "locator_example"; // string | 
$fields = "fields_example"; // string | 

try {
    $result = $apiInstance->serveProfiles($locator, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudInstanceApi->serveProfiles: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
locator string [optional]
fields string [optional]

Return type

\TeamCityClient\Model\CloudProfiles

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

startInstance

startInstance($body, $fields)

Example

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

$apiInstance = new TeamCityClient\Api\CloudInstanceApi(
    // 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()
);
$body = new \TeamCityClient\Model\CloudInstance(); // \TeamCityClient\Model\CloudInstance | 
$fields = "fields_example"; // string | 

try {
    $apiInstance->startInstance($body, $fields);
} catch (Exception $e) {
    echo 'Exception when calling CloudInstanceApi->startInstance: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
body \TeamCityClient\Model\CloudInstance [optional]
fields string [optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

stopInstance

stopInstance($instance_locator)

Example

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

$apiInstance = new TeamCityClient\Api\CloudInstanceApi(
    // 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()
);
$instance_locator = "instance_locator_example"; // string | 

try {
    $apiInstance->stopInstance($instance_locator);
} catch (Exception $e) {
    echo 'Exception when calling CloudInstanceApi->stopInstance: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
instance_locator string

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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