OpenAPI\Client\CloudServiceApi

All URIs are relative to https://api.beget.com, except if the operation defines another base path.

Method	HTTP request	Description
cloudServiceBindProject()	PUT /v1/cloud/{service_id}/project
cloudServiceChangeConfiguration()	PATCH /v1/cloud/{service_id}/configuration
cloudServiceChangePinned()	PUT /v1/cloud/{service_id}/pin
cloudServiceCreate()	POST /v1/cloud
cloudServiceGet()	GET /v1/cloud/{service_id}
cloudServiceGetConfigurationList()	GET /v1/cloud/configuration
cloudServiceGetList()	GET /v1/cloud
cloudServiceRemove()	DELETE /v1/cloud/{service_id}
cloudServiceUpdate()	PATCH /v1/cloud/{service_id}

`cloudServiceBindProject()`

cloudServiceBindProject($service_id, $cloud_bind_project_request): \OpenAPI\Client\Model\CloudBindProjectResponse

Example

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


// Configure Bearer (JWT) authorization: bearerAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CloudServiceApi(
    // 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(),
    $config
);
$service_id = 'service_id_example'; // string
$cloud_bind_project_request = new \OpenAPI\Client\Model\CloudBindProjectRequest(); // \OpenAPI\Client\Model\CloudBindProjectRequest

try {
    $result = $apiInstance->cloudServiceBindProject($service_id, $cloud_bind_project_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudServiceApi->cloudServiceBindProject: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
service_id	string
cloud_bind_project_request	\OpenAPI\Client\Model\CloudBindProjectRequest

Return type

\OpenAPI\Client\Model\CloudBindProjectResponse

Authorization

bearerAuth

HTTP request headers

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

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

`cloudServiceChangeConfiguration()`

cloudServiceChangeConfiguration($service_id, $cloud_change_configuration_request): \OpenAPI\Client\Model\CloudChangeConfigurationResponse

Example

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


// Configure Bearer (JWT) authorization: bearerAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CloudServiceApi(
    // 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(),
    $config
);
$service_id = 'service_id_example'; // string
$cloud_change_configuration_request = new \OpenAPI\Client\Model\CloudChangeConfigurationRequest(); // \OpenAPI\Client\Model\CloudChangeConfigurationRequest

try {
    $result = $apiInstance->cloudServiceChangeConfiguration($service_id, $cloud_change_configuration_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudServiceApi->cloudServiceChangeConfiguration: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
service_id	string
cloud_change_configuration_request	\OpenAPI\Client\Model\CloudChangeConfigurationRequest

Return type

\OpenAPI\Client\Model\CloudChangeConfigurationResponse

Authorization

bearerAuth

HTTP request headers

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

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

`cloudServiceChangePinned()`

cloudServiceChangePinned($service_id, $cloud_change_pinned_request): \OpenAPI\Client\Model\CloudChangePinnedResponse

Example

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


// Configure Bearer (JWT) authorization: bearerAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CloudServiceApi(
    // 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(),
    $config
);
$service_id = 'service_id_example'; // string
$cloud_change_pinned_request = new \OpenAPI\Client\Model\CloudChangePinnedRequest(); // \OpenAPI\Client\Model\CloudChangePinnedRequest

try {
    $result = $apiInstance->cloudServiceChangePinned($service_id, $cloud_change_pinned_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudServiceApi->cloudServiceChangePinned: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
service_id	string
cloud_change_pinned_request	\OpenAPI\Client\Model\CloudChangePinnedRequest

Return type

\OpenAPI\Client\Model\CloudChangePinnedResponse

Authorization

bearerAuth

HTTP request headers

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

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

`cloudServiceCreate()`

cloudServiceCreate($cloud_create_request): \OpenAPI\Client\Model\CloudCreateResponse

Example

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


// Configure Bearer (JWT) authorization: bearerAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CloudServiceApi(
    // 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(),
    $config
);
$cloud_create_request = new \OpenAPI\Client\Model\CloudCreateRequest(); // \OpenAPI\Client\Model\CloudCreateRequest

try {
    $result = $apiInstance->cloudServiceCreate($cloud_create_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudServiceApi->cloudServiceCreate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
cloud_create_request	\OpenAPI\Client\Model\CloudCreateRequest

Return type

\OpenAPI\Client\Model\CloudCreateResponse

Authorization

bearerAuth

HTTP request headers

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

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

`cloudServiceGet()`

cloudServiceGet($service_id): \OpenAPI\Client\Model\CloudGetResponse

Example

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


// Configure Bearer (JWT) authorization: bearerAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CloudServiceApi(
    // 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(),
    $config
);
$service_id = 'service_id_example'; // string

try {
    $result = $apiInstance->cloudServiceGet($service_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudServiceApi->cloudServiceGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
service_id	string

Return type

\OpenAPI\Client\Model\CloudGetResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`cloudServiceGetConfigurationList()`

cloudServiceGetConfigurationList(): \OpenAPI\Client\Model\CloudGetConfigurationListResponse

Example

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


// Configure Bearer (JWT) authorization: bearerAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CloudServiceApi(
    // 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(),
    $config
);

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

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\CloudGetConfigurationListResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`cloudServiceGetList()`

cloudServiceGetList($offset, $limit, $sort, $filter, $view): \OpenAPI\Client\Model\CloudGetListResponse

Example

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


// Configure Bearer (JWT) authorization: bearerAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CloudServiceApi(
    // 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(),
    $config
);
$offset = 56; // int
$limit = 56; // int
$sort = 'sort_example'; // string
$filter = 'filter_example'; // string
$view = 'view_example'; // string

try {
    $result = $apiInstance->cloudServiceGetList($offset, $limit, $sort, $filter, $view);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudServiceApi->cloudServiceGetList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Notes
offset	int	[optional]
limit	int	[optional]
sort	string	[optional]
filter	string	[optional]
view	string	[optional]

Return type

\OpenAPI\Client\Model\CloudGetListResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`cloudServiceRemove()`

cloudServiceRemove($service_id): \OpenAPI\Client\Model\CloudRemoveResponse

Example

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


// Configure Bearer (JWT) authorization: bearerAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CloudServiceApi(
    // 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(),
    $config
);
$service_id = 'service_id_example'; // string

try {
    $result = $apiInstance->cloudServiceRemove($service_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudServiceApi->cloudServiceRemove: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
service_id	string

Return type

\OpenAPI\Client\Model\CloudRemoveResponse

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`cloudServiceUpdate()`

cloudServiceUpdate($service_id, $cloud_update_request): \OpenAPI\Client\Model\CloudUpdateResponse

Example

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


// Configure Bearer (JWT) authorization: bearerAuth
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\CloudServiceApi(
    // 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(),
    $config
);
$service_id = 'service_id_example'; // string
$cloud_update_request = new \OpenAPI\Client\Model\CloudUpdateRequest(); // \OpenAPI\Client\Model\CloudUpdateRequest

try {
    $result = $apiInstance->cloudServiceUpdate($service_id, $cloud_update_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CloudServiceApi->cloudServiceUpdate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
service_id	string
cloud_update_request	\OpenAPI\Client\Model\CloudUpdateRequest

Return type

\OpenAPI\Client\Model\CloudUpdateResponse

Authorization

bearerAuth

HTTP request headers

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

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

FilesExpand file tree

CloudServiceApi.md

Latest commit

History

CloudServiceApi.md

File metadata and controls

OpenAPI\Client\CloudServiceApi

cloudServiceBindProject()

Example

Parameters

Return type

Authorization

HTTP request headers

cloudServiceChangeConfiguration()

Example

Parameters

Return type

Authorization

HTTP request headers

cloudServiceChangePinned()

Example

Parameters

Return type

Authorization

HTTP request headers

cloudServiceCreate()

Example

Parameters

Return type

Authorization

HTTP request headers

cloudServiceGet()

Example

Parameters

Return type

Authorization

HTTP request headers

cloudServiceGetConfigurationList()

Example

Parameters

Return type

Authorization

HTTP request headers

cloudServiceGetList()

Example

Parameters

Return type

Authorization

HTTP request headers

cloudServiceRemove()

Example

Parameters

Return type

Authorization

HTTP request headers

cloudServiceUpdate()

Example

Parameters

Return type

Authorization

HTTP request headers

`cloudServiceBindProject()`

`cloudServiceChangeConfiguration()`

`cloudServiceChangePinned()`

`cloudServiceCreate()`

`cloudServiceGet()`

`cloudServiceGetConfigurationList()`

`cloudServiceGetList()`

`cloudServiceRemove()`

`cloudServiceUpdate()`