OpenAPI\Client\PostgresqlServiceApi

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

Method	HTTP request	Description
postgresqlServiceCreateDb()	POST /v1/cloud/postgresql/{service_id}/db
postgresqlServiceCreateRole()	POST /v1/cloud/postgresql/{service_id}/role
postgresqlServiceGetConfig()	GET /v1/cloud/postgresql/{service_id}/config
postgresqlServiceGetDbList()	GET /v1/cloud/postgresql/{service_id}/db
postgresqlServiceGetRemoteAccess()	GET /v1/cloud/postgresql/{service_id}/remote-access
postgresqlServiceGetRoleList()	GET /v1/cloud/postgresql/{service_id}/role
postgresqlServiceRemoveDb()	DELETE /v1/cloud/postgresql/{service_id}/db/{db_name}
postgresqlServiceRemoveRole()	DELETE /v1/cloud/postgresql/{service_id}/role/{role_name}
postgresqlServiceSetConfig()	PUT /v1/cloud/postgresql/{service_id}/config
postgresqlServiceUpdateDb()	PATCH /v1/cloud/postgresql/{service_id}/db/{db_name}
postgresqlServiceUpdateRemoteAccess()	PUT /v1/cloud/postgresql/{service_id}/remote-access
postgresqlServiceUpdateRole()	PATCH /v1/cloud/postgresql/{service_id}/role/{role_name}

`postgresqlServiceCreateDb()`

postgresqlServiceCreateDb($service_id, $postgresql_pg_create_db_request): \OpenAPI\Client\Model\PostgresqlPgCreateDbResponse

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\PostgresqlServiceApi(
    // 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
$postgresql_pg_create_db_request = new \OpenAPI\Client\Model\PostgresqlPgCreateDbRequest(); // \OpenAPI\Client\Model\PostgresqlPgCreateDbRequest

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

Parameters

Name	Type	Description	Notes
service_id	string
postgresql_pg_create_db_request	\OpenAPI\Client\Model\PostgresqlPgCreateDbRequest

Return type

\OpenAPI\Client\Model\PostgresqlPgCreateDbResponse

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]

`postgresqlServiceCreateRole()`

postgresqlServiceCreateRole($service_id, $postgresql_pg_create_role_request): \OpenAPI\Client\Model\PostgresqlPgCreateRoleResponse

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\PostgresqlServiceApi(
    // 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
$postgresql_pg_create_role_request = new \OpenAPI\Client\Model\PostgresqlPgCreateRoleRequest(); // \OpenAPI\Client\Model\PostgresqlPgCreateRoleRequest

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

Parameters

Name	Type	Description	Notes
service_id	string
postgresql_pg_create_role_request	\OpenAPI\Client\Model\PostgresqlPgCreateRoleRequest

Return type

\OpenAPI\Client\Model\PostgresqlPgCreateRoleResponse

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]

`postgresqlServiceGetConfig()`

postgresqlServiceGetConfig($service_id): \OpenAPI\Client\Model\PostgresqlPgGetConfigResponse

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

Parameters

Name	Type	Description	Notes
service_id	string

Return type

\OpenAPI\Client\Model\PostgresqlPgGetConfigResponse

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]

`postgresqlServiceGetDbList()`

postgresqlServiceGetDbList($service_id): \OpenAPI\Client\Model\PostgresqlPgGetDbListResponse

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

Parameters

Name	Type	Description	Notes
service_id	string

Return type

\OpenAPI\Client\Model\PostgresqlPgGetDbListResponse

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]

`postgresqlServiceGetRemoteAccess()`

postgresqlServiceGetRemoteAccess($service_id): \OpenAPI\Client\Model\PostgresqlPgGetRemoteAccessResponse

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

Parameters

Name	Type	Description	Notes
service_id	string

Return type

\OpenAPI\Client\Model\PostgresqlPgGetRemoteAccessResponse

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]

`postgresqlServiceGetRoleList()`

postgresqlServiceGetRoleList($service_id): \OpenAPI\Client\Model\PostgresqlPgGetRoleListResponse

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

Parameters

Name	Type	Description	Notes
service_id	string

Return type

\OpenAPI\Client\Model\PostgresqlPgGetRoleListResponse

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]

`postgresqlServiceRemoveDb()`

postgresqlServiceRemoveDb($service_id, $db_name): \OpenAPI\Client\Model\PostgresqlPgRemoveDbResponse

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

Parameters

Name	Type	Description	Notes
service_id	string
db_name	string

Return type

\OpenAPI\Client\Model\PostgresqlPgRemoveDbResponse

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]

`postgresqlServiceRemoveRole()`

postgresqlServiceRemoveRole($service_id, $role_name): \OpenAPI\Client\Model\PostgresqlPgRemoveRoleResponse

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\PostgresqlServiceApi(
    // 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
$role_name = 'role_name_example'; // string

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

Parameters

Name	Type	Description	Notes
service_id	string
role_name	string

Return type

\OpenAPI\Client\Model\PostgresqlPgRemoveRoleResponse

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]

`postgresqlServiceSetConfig()`

postgresqlServiceSetConfig($service_id, $postgresql_pg_set_config_request): \OpenAPI\Client\Model\PostgresqlPgSetConfigResponse

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\PostgresqlServiceApi(
    // 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
$postgresql_pg_set_config_request = new \OpenAPI\Client\Model\PostgresqlPgSetConfigRequest(); // \OpenAPI\Client\Model\PostgresqlPgSetConfigRequest

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

Parameters

Name	Type	Description	Notes
service_id	string
postgresql_pg_set_config_request	\OpenAPI\Client\Model\PostgresqlPgSetConfigRequest

Return type

\OpenAPI\Client\Model\PostgresqlPgSetConfigResponse

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]

`postgresqlServiceUpdateDb()`

postgresqlServiceUpdateDb($service_id, $db_name, $postgresql_pg_update_db_request): \OpenAPI\Client\Model\PostgresqlPgUpdateDbResponse

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\PostgresqlServiceApi(
    // 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
$postgresql_pg_update_db_request = new \OpenAPI\Client\Model\PostgresqlPgUpdateDbRequest(); // \OpenAPI\Client\Model\PostgresqlPgUpdateDbRequest

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

Parameters

Name	Type	Description	Notes
service_id	string
db_name	string
postgresql_pg_update_db_request	\OpenAPI\Client\Model\PostgresqlPgUpdateDbRequest

Return type

\OpenAPI\Client\Model\PostgresqlPgUpdateDbResponse

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]

`postgresqlServiceUpdateRemoteAccess()`

postgresqlServiceUpdateRemoteAccess($service_id, $postgresql_pg_update_remote_access_request): \OpenAPI\Client\Model\PostgresqlPgUpdateRemoteAccessResponse

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\PostgresqlServiceApi(
    // 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
$postgresql_pg_update_remote_access_request = new \OpenAPI\Client\Model\PostgresqlPgUpdateRemoteAccessRequest(); // \OpenAPI\Client\Model\PostgresqlPgUpdateRemoteAccessRequest

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

Parameters

Name	Type	Description	Notes
service_id	string
postgresql_pg_update_remote_access_request	\OpenAPI\Client\Model\PostgresqlPgUpdateRemoteAccessRequest

Return type

\OpenAPI\Client\Model\PostgresqlPgUpdateRemoteAccessResponse

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]

`postgresqlServiceUpdateRole()`

postgresqlServiceUpdateRole($service_id, $role_name, $postgresql_pg_update_role_request): \OpenAPI\Client\Model\PostgresqlPgUpdateRoleResponse

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\PostgresqlServiceApi(
    // 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
$role_name = 'role_name_example'; // string
$postgresql_pg_update_role_request = new \OpenAPI\Client\Model\PostgresqlPgUpdateRoleRequest(); // \OpenAPI\Client\Model\PostgresqlPgUpdateRoleRequest

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

Parameters

Name	Type	Description	Notes
service_id	string
role_name	string
postgresql_pg_update_role_request	\OpenAPI\Client\Model\PostgresqlPgUpdateRoleRequest

Return type

\OpenAPI\Client\Model\PostgresqlPgUpdateRoleResponse

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]

Files

PostgresqlServiceApi.md

Latest commit

History

PostgresqlServiceApi.md

File metadata and controls

OpenAPI\Client\PostgresqlServiceApi

postgresqlServiceCreateDb()

Example

Parameters

Return type

Authorization

HTTP request headers

postgresqlServiceCreateRole()

Example

Parameters

Return type

Authorization

HTTP request headers

postgresqlServiceGetConfig()

Example

Parameters

Return type

Authorization

HTTP request headers

postgresqlServiceGetDbList()

Example

Parameters

Return type

Authorization

HTTP request headers

postgresqlServiceGetRemoteAccess()

Example

Parameters

Return type

Authorization

HTTP request headers

postgresqlServiceGetRoleList()

Example

Parameters

Return type

Authorization

HTTP request headers

postgresqlServiceRemoveDb()

Example

Parameters

Return type

Authorization

HTTP request headers

postgresqlServiceRemoveRole()

Example

Parameters

Return type

Authorization

HTTP request headers

postgresqlServiceSetConfig()

Example

Parameters

Return type

Authorization

HTTP request headers

postgresqlServiceUpdateDb()

Example

Parameters

Return type

Authorization

HTTP request headers

postgresqlServiceUpdateRemoteAccess()

Example

Parameters

Return type

Authorization

HTTP request headers

postgresqlServiceUpdateRole()

Example

Parameters

Return type

Authorization

HTTP request headers

`postgresqlServiceCreateDb()`

`postgresqlServiceCreateRole()`

`postgresqlServiceGetConfig()`

`postgresqlServiceGetDbList()`

`postgresqlServiceGetRemoteAccess()`

`postgresqlServiceGetRoleList()`

`postgresqlServiceRemoveDb()`

`postgresqlServiceRemoveRole()`

`postgresqlServiceSetConfig()`

`postgresqlServiceUpdateDb()`

`postgresqlServiceUpdateRemoteAccess()`

`postgresqlServiceUpdateRole()`