OpenAPI\Client\MysqlServiceApi

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

Method	HTTP request	Description
mysqlServiceChangeAccessPassword()	PATCH /v1/cloud/mysql/{service_id}/db/{db_name}/access/{host}
mysqlServiceCreateAccess()	POST /v1/cloud/mysql/{service_id}/db/{db_name}/access
mysqlServiceCreateDb()	POST /v1/cloud/mysql/{service_id}/db
mysqlServiceGetConfig()	GET /v1/cloud/mysql/{service_id}/config
mysqlServiceGetDbList()	GET /v1/cloud/mysql/{service_id}/db
mysqlServiceRemoveAccess()	DELETE /v1/cloud/mysql/{service_id}/db/{db_name}/access/{host}
mysqlServiceRemoveDb()	DELETE /v1/cloud/mysql/{service_id}/db/{db_name}
mysqlServiceSetConfig()	PUT /v1/cloud/mysql/{service_id}/config
mysqlServiceUpdateDb()	PATCH /v1/cloud/mysql/{service_id}/db/{db_name}

`mysqlServiceChangeAccessPassword()`

mysqlServiceChangeAccessPassword($service_id, $db_name, $host, $mysql_change_access_password_request): \OpenAPI\Client\Model\MysqlChangeAccessPasswordResponse

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\MysqlServiceApi(
    // 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
$db_name = 'db_name_example'; // string
$host = 'host_example'; // string
$mysql_change_access_password_request = new \OpenAPI\Client\Model\MysqlChangeAccessPasswordRequest(); // \OpenAPI\Client\Model\MysqlChangeAccessPasswordRequest

try {
    $result = $apiInstance->mysqlServiceChangeAccessPassword($service_id, $db_name, $host, $mysql_change_access_password_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MysqlServiceApi->mysqlServiceChangeAccessPassword: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
service_id	string
db_name	string
host	string
mysql_change_access_password_request	\OpenAPI\Client\Model\MysqlChangeAccessPasswordRequest

Return type

\OpenAPI\Client\Model\MysqlChangeAccessPasswordResponse

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]

`mysqlServiceCreateAccess()`

mysqlServiceCreateAccess($service_id, $db_name, $mysql_create_access_request): \OpenAPI\Client\Model\MysqlCreateAccessResponse

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\MysqlServiceApi(
    // 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
$db_name = 'db_name_example'; // string
$mysql_create_access_request = new \OpenAPI\Client\Model\MysqlCreateAccessRequest(); // \OpenAPI\Client\Model\MysqlCreateAccessRequest

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

Parameters

Name	Type	Description	Notes
service_id	string
db_name	string
mysql_create_access_request	\OpenAPI\Client\Model\MysqlCreateAccessRequest

Return type

\OpenAPI\Client\Model\MysqlCreateAccessResponse

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]

`mysqlServiceCreateDb()`

mysqlServiceCreateDb($service_id, $mysql_create_db_request): \OpenAPI\Client\Model\MysqlCreateDbResponse

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\MysqlServiceApi(
    // 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
$mysql_create_db_request = new \OpenAPI\Client\Model\MysqlCreateDbRequest(); // \OpenAPI\Client\Model\MysqlCreateDbRequest

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

Parameters

Name	Type	Description	Notes
service_id	string
mysql_create_db_request	\OpenAPI\Client\Model\MysqlCreateDbRequest

Return type

\OpenAPI\Client\Model\MysqlCreateDbResponse

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]

`mysqlServiceGetConfig()`

mysqlServiceGetConfig($service_id): \OpenAPI\Client\Model\MysqlGetConfigResponse

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\MysqlServiceApi(
    // 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->mysqlServiceGetConfig($service_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MysqlServiceApi->mysqlServiceGetConfig: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
service_id	string

Return type

\OpenAPI\Client\Model\MysqlGetConfigResponse

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]

`mysqlServiceGetDbList()`

mysqlServiceGetDbList($service_id): \OpenAPI\Client\Model\MysqlGetDbListResponse

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\MysqlServiceApi(
    // 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->mysqlServiceGetDbList($service_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MysqlServiceApi->mysqlServiceGetDbList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
service_id	string

Return type

\OpenAPI\Client\Model\MysqlGetDbListResponse

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]

`mysqlServiceRemoveAccess()`

mysqlServiceRemoveAccess($service_id, $db_name, $host): \OpenAPI\Client\Model\MysqlRemoveAccessResponse

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\MysqlServiceApi(
    // 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
$db_name = 'db_name_example'; // string
$host = 'host_example'; // string

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

Parameters

Name	Type	Description	Notes
service_id	string
db_name	string
host	string

Return type

\OpenAPI\Client\Model\MysqlRemoveAccessResponse

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]

`mysqlServiceRemoveDb()`

mysqlServiceRemoveDb($service_id, $db_name): \OpenAPI\Client\Model\MysqlRemoveDbResponse

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\MysqlServiceApi(
    // 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
$db_name = 'db_name_example'; // string

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

Parameters

Name	Type	Description	Notes
service_id	string
db_name	string

Return type

\OpenAPI\Client\Model\MysqlRemoveDbResponse

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]

`mysqlServiceSetConfig()`

mysqlServiceSetConfig($service_id, $mysql_set_config_request): \OpenAPI\Client\Model\MysqlSetConfigResponse

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\MysqlServiceApi(
    // 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
$mysql_set_config_request = new \OpenAPI\Client\Model\MysqlSetConfigRequest(); // \OpenAPI\Client\Model\MysqlSetConfigRequest

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

Parameters

Name	Type	Description	Notes
service_id	string
mysql_set_config_request	\OpenAPI\Client\Model\MysqlSetConfigRequest

Return type

\OpenAPI\Client\Model\MysqlSetConfigResponse

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]

`mysqlServiceUpdateDb()`

mysqlServiceUpdateDb($service_id, $db_name, $mysql_update_db_request): \OpenAPI\Client\Model\MysqlUpdateDbResponse

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\MysqlServiceApi(
    // 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
$db_name = 'db_name_example'; // string
$mysql_update_db_request = new \OpenAPI\Client\Model\MysqlUpdateDbRequest(); // \OpenAPI\Client\Model\MysqlUpdateDbRequest

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

Parameters

Name	Type	Description	Notes
service_id	string
db_name	string
mysql_update_db_request	\OpenAPI\Client\Model\MysqlUpdateDbRequest

Return type

\OpenAPI\Client\Model\MysqlUpdateDbResponse

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

MysqlServiceApi.md

Latest commit

History

MysqlServiceApi.md

File metadata and controls

OpenAPI\Client\MysqlServiceApi

mysqlServiceChangeAccessPassword()

Example

Parameters

Return type

Authorization

HTTP request headers

mysqlServiceCreateAccess()

Example

Parameters

Return type

Authorization

HTTP request headers

mysqlServiceCreateDb()

Example

Parameters

Return type

Authorization

HTTP request headers

mysqlServiceGetConfig()

Example

Parameters

Return type

Authorization

HTTP request headers

mysqlServiceGetDbList()

Example

Parameters

Return type

Authorization

HTTP request headers

mysqlServiceRemoveAccess()

Example

Parameters

Return type

Authorization

HTTP request headers

mysqlServiceRemoveDb()

Example

Parameters

Return type

Authorization

HTTP request headers

mysqlServiceSetConfig()

Example

Parameters

Return type

Authorization

HTTP request headers

mysqlServiceUpdateDb()

Example

Parameters

Return type

Authorization

HTTP request headers

`mysqlServiceChangeAccessPassword()`

`mysqlServiceCreateAccess()`

`mysqlServiceCreateDb()`

`mysqlServiceGetConfig()`

`mysqlServiceGetDbList()`

`mysqlServiceRemoveAccess()`

`mysqlServiceRemoveDb()`

`mysqlServiceSetConfig()`

`mysqlServiceUpdateDb()`