net.minidev.ovh.api

Class ApiOvhPaasdatabase

java.lang.Object

net.minidev.ovh.core.ApiOvhBase

net.minidev.ovh.api.ApiOvhPaasdatabase

public class ApiOvhPaasdatabase
extends ApiOvhBase

BasePath:https://eu.api.ovh.com/1.0 ResourcePath:/paas/database version:1.0

Field Summary

Fields inherited from class net.minidev.ovh.core.ApiOvhBase

core

Constructor Summary

Constructors

Constructor and Description
ApiOvhPaasdatabase(ApiOvhCore core)

Method Summary

Modifier and Type	Method and Description
ArrayList<String>	GET() List available services REST: GET /paas/database API beta
ArrayList<String>	image_GET(OvhStatus status, OvhType type) Name of all available images REST: GET /paas/database/image
OvhImage	image_imageName_GET(String imageName) Get this object properties REST: GET /paas/database/image/{imageName}
ArrayList<String>	offer_GET(OvhStatus status) Name of all available offers REST: GET /paas/database/offer
OvhOffer	offer_offerName_GET(String offerName) Get this object properties REST: GET /paas/database/offer/{offerName}
ArrayList<String>	region_GET(OvhStatus status) Name of all available regions REST: GET /paas/database/region
OvhRegion	region_regionName_GET(String regionName) Get this object properties REST: GET /paas/database/region/{regionName}
OvhDump	serviceName_dump_dumpId_DELETE(String serviceName, String dumpId) Delete the dump REST: DELETE /paas/database/{serviceName}/dump/{dumpId}
OvhDump	serviceName_dump_dumpId_GET(String serviceName, String dumpId) Get this object properties REST: GET /paas/database/{serviceName}/dump/{dumpId}
OvhDump	serviceName_dump_dumpId_restore_POST(String serviceName, String dumpId, String instanceId, String databaseName) Request the restore from this dump REST: POST /paas/database/{serviceName}/dump/{dumpId}/restore
ArrayList<String>	serviceName_dump_GET(String serviceName, Date creationDate, String databaseName, Date expirationDate, String instanceId, OvhStatus status) Dumps linked to your project REST: GET /paas/database/{serviceName}/dump
OvhService	serviceName_GET(String serviceName) Get this object properties REST: GET /paas/database/{serviceName}
ArrayList<String>	serviceName_instance_GET(String serviceName, OvhStatus status) Instances linked to your project REST: GET /paas/database/{serviceName}/instance
OvhInstance	serviceName_instance_instanceId_changeSftpPassword_POST(String serviceName, String instanceId, String password) Change the ftp password of the instance REST: POST /paas/database/{serviceName}/instance/{instanceId}/changeSftpPassword
OvhInstanceConfiguration	serviceName_instance_instanceId_configuration_GET(String serviceName, String instanceId) Get this object properties REST: GET /paas/database/{serviceName}/instance/{instanceId}/configuration
OvhInstanceConfiguration	serviceName_instance_instanceId_configuration_update_POST(String serviceName, String instanceId, OvhSafeKeyValue<String>[] parameters) Update the instance configuration REST: POST /paas/database/{serviceName}/instance/{instanceId}/configuration/update
OvhInstanceDatabase	serviceName_instance_instanceId_database_databaseName_DELETE(String serviceName, String instanceId, String databaseName) Delete the database REST: DELETE /paas/database/{serviceName}/instance/{instanceId}/database/{databaseName}
OvhInstanceDatabaseDump	serviceName_instance_instanceId_database_databaseName_dump_dumpId_DELETE(String serviceName, String instanceId, String databaseName, String dumpId) Delete dump before expiration date REST: DELETE /paas/database/{serviceName}/instance/{instanceId}/database/{databaseName}/dump/{dumpId}
OvhInstanceDatabaseDump	serviceName_instance_instanceId_database_databaseName_dump_dumpId_GET(String serviceName, String instanceId, String databaseName, String dumpId) Get this object properties REST: GET /paas/database/{serviceName}/instance/{instanceId}/database/{databaseName}/dump/{dumpId}
OvhInstanceDatabaseDump	serviceName_instance_instanceId_database_databaseName_dump_dumpId_restore_POST(String serviceName, String instanceId, String databaseName, String dumpId) Request the restore of this dump REST: POST /paas/database/{serviceName}/instance/{instanceId}/database/{databaseName}/dump/{dumpId}/restore
ArrayList<String>	serviceName_instance_instanceId_database_databaseName_dump_GET(String serviceName, String instanceId, String databaseName, Date creationDate, Date expirationDate, OvhStatus status) Dump available for your database REST: GET /paas/database/{serviceName}/instance/{instanceId}/database/{databaseName}/dump
OvhInstanceDatabaseDump	serviceName_instance_instanceId_database_databaseName_dump_POST(String serviceName, String instanceId, String databaseName, String email, String name) Request the dump of this database REST: POST /paas/database/{serviceName}/instance/{instanceId}/database/{databaseName}/dump
OvhInstanceDatabaseExtension	serviceName_instance_instanceId_database_databaseName_extension_extensionName_disable_POST(String serviceName, String instanceId, String databaseName, String extensionName) Disable an extension from a database REST: POST /paas/database/{serviceName}/instance/{instanceId}/database/{databaseName}/extension/{extensionName}/disable
OvhInstanceDatabaseExtension	serviceName_instance_instanceId_database_databaseName_extension_extensionName_enable_POST(String serviceName, String instanceId, String databaseName, String extensionName) Enable an extension on a database REST: POST /paas/database/{serviceName}/instance/{instanceId}/database/{databaseName}/extension/{extensionName}/enable
OvhInstanceDatabaseExtension	serviceName_instance_instanceId_database_databaseName_extension_extensionName_GET(String serviceName, String instanceId, String databaseName, String extensionName) Get this object properties REST: GET /paas/database/{serviceName}/instance/{instanceId}/database/{databaseName}/extension/{extensionName}
ArrayList<String>	serviceName_instance_instanceId_database_databaseName_extension_GET(String serviceName, String instanceId, String databaseName, String extensionName, OvhStatus status) Extensions linked to your database REST: GET /paas/database/{serviceName}/instance/{instanceId}/database/{databaseName}/extension
OvhInstanceDatabase	serviceName_instance_instanceId_database_databaseName_GET(String serviceName, String instanceId, String databaseName) Get this object properties REST: GET /paas/database/{serviceName}/instance/{instanceId}/database/{databaseName}
ArrayList<String>	serviceName_instance_instanceId_database_GET(String serviceName, String instanceId, OvhStatus status) Databases available in your instance REST: GET /paas/database/{serviceName}/instance/{instanceId}/database
OvhInstanceDatabase	serviceName_instance_instanceId_database_POST(String serviceName, String instanceId, String databaseName) Create a new database on your instance REST: POST /paas/database/{serviceName}/instance/{instanceId}/database
OvhInstance	serviceName_instance_instanceId_DELETE(String serviceName, String instanceId) Delete instance REST: DELETE /paas/database/{serviceName}/instance/{instanceId}
OvhInstance	serviceName_instance_instanceId_GET(String serviceName, String instanceId) Get this object properties REST: GET /paas/database/{serviceName}/instance/{instanceId}
ArrayList<String>	serviceName_instance_instanceId_grant_GET(String serviceName, String instanceId, OvhStatus status) Grants of sql users on your sql databases REST: GET /paas/database/{serviceName}/instance/{instanceId}/grant
OvhInstanceGrant	serviceName_instance_instanceId_grant_grantId_DELETE(String serviceName, String instanceId, String grantId) Delete a grant on a database REST: DELETE /paas/database/{serviceName}/instance/{instanceId}/grant/{grantId}
OvhInstanceGrant	serviceName_instance_instanceId_grant_grantId_GET(String serviceName, String instanceId, String grantId) Get this object properties REST: GET /paas/database/{serviceName}/instance/{instanceId}/grant/{grantId}
void	serviceName_instance_instanceId_grant_grantId_PUT(String serviceName, String instanceId, String grantId, OvhInstanceGrant body) Alter this object properties REST: PUT /paas/database/{serviceName}/instance/{instanceId}/grant/{grantId}
OvhInstanceGrant	serviceName_instance_instanceId_grant_POST(String serviceName, String instanceId, String databaseName, OvhType grantType, String userName) Add a grant on a database REST: POST /paas/database/{serviceName}/instance/{instanceId}/grant
void	serviceName_instance_instanceId_PUT(String serviceName, String instanceId, OvhInstance body) Alter this object properties REST: PUT /paas/database/{serviceName}/instance/{instanceId}
OvhInstance	serviceName_instance_instanceId_resize_POST(String serviceName, String instanceId, String offerName) Resize the instance (by migrating the offer) REST: POST /paas/database/{serviceName}/instance/{instanceId}/resize
OvhInstance	serviceName_instance_instanceId_restart_POST(String serviceName, String instanceId) Restart the instance REST: POST /paas/database/{serviceName}/instance/{instanceId}/restart
OvhInstance	serviceName_instance_instanceId_start_POST(String serviceName, String instanceId) Start the instance REST: POST /paas/database/{serviceName}/instance/{instanceId}/start
OvhInstance	serviceName_instance_instanceId_stop_POST(String serviceName, String instanceId) Stop the instance REST: POST /paas/database/{serviceName}/instance/{instanceId}/stop
OvhInstance	serviceName_instance_instanceId_upgrade_POST(String serviceName, String instanceId, String imageName) Upgrade the instance with a new image REST: POST /paas/database/{serviceName}/instance/{instanceId}/upgrade
ArrayList<String>	serviceName_instance_instanceId_user_GET(String serviceName, String instanceId, OvhStatus status) Users allowed to connect on a databases of an instance REST: GET /paas/database/{serviceName}/instance/{instanceId}/user
OvhInstanceUser	serviceName_instance_instanceId_user_POST(String serviceName, String instanceId, String password, String userName) Create a new user on your databases REST: POST /paas/database/{serviceName}/instance/{instanceId}/user
OvhInstanceUser	serviceName_instance_instanceId_user_userName_changePassword_POST(String serviceName, String instanceId, String userName, String password) Request a password change for a user REST: POST /paas/database/{serviceName}/instance/{instanceId}/user/{userName}/changePassword
OvhInstanceUser	serviceName_instance_instanceId_user_userName_DELETE(String serviceName, String instanceId, String userName) Delete a user REST: DELETE /paas/database/{serviceName}/instance/{instanceId}/user/{userName}
OvhInstanceUser	serviceName_instance_instanceId_user_userName_GET(String serviceName, String instanceId, String userName) Get this object properties REST: GET /paas/database/{serviceName}/instance/{instanceId}/user/{userName}
ArrayList<String>	serviceName_instance_instanceId_whitelist_GET(String serviceName, String instanceId, OvhStatus status) The whitelist configuration (used to access to your instance) REST: GET /paas/database/{serviceName}/instance/{instanceId}/whitelist
OvhInstanceWhitelist	serviceName_instance_instanceId_whitelist_ip_DELETE(String serviceName, String instanceId, String ip) Delete ain IP whitelist REST: DELETE /paas/database/{serviceName}/instance/{instanceId}/whitelist/{ip}
OvhInstanceWhitelist	serviceName_instance_instanceId_whitelist_ip_GET(String serviceName, String instanceId, String ip) Get this object properties REST: GET /paas/database/{serviceName}/instance/{instanceId}/whitelist/{ip}
void	serviceName_instance_instanceId_whitelist_ip_PUT(String serviceName, String instanceId, String ip, OvhInstanceWhitelist body) Alter this object properties REST: PUT /paas/database/{serviceName}/instance/{instanceId}/whitelist/{ip}
OvhInstanceWhitelist	serviceName_instance_instanceId_whitelist_POST(String serviceName, String instanceId, String ip, String name, Boolean service, Boolean sftp) Create a new IP whitelist REST: POST /paas/database/{serviceName}/instance/{instanceId}/whitelist
ArrayList<OvhData>	serviceName_instance_POST(String serviceName, OvhParameters[] parameters) Create new instance REST: POST /paas/database/{serviceName}/instance
void	serviceName_PUT(String serviceName, OvhService body) Alter this object properties REST: PUT /paas/database/{serviceName}
OvhService	serviceName_serviceInfos_GET(String serviceName) Get this object properties REST: GET /paas/database/{serviceName}/serviceInfos
void	serviceName_serviceInfos_PUT(String serviceName, OvhService body) Alter this object properties REST: PUT /paas/database/{serviceName}/serviceInfos
ArrayList<String>	serviceName_task_GET(String serviceName, String function, OvhStatus status) Tasks linked your project REST: GET /paas/database/{serviceName}/task
OvhTask	serviceName_task_taskId_GET(String serviceName, String taskId) Get this object properties REST: GET /paas/database/{serviceName}/task/{taskId}

Methods inherited from class net.minidev.ovh.core.ApiOvhBase

addBody, convertTo, convertTo, exec, execN, getCore, getNic, path, query

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApiOvhPaasdatabase

public ApiOvhPaasdatabase(ApiOvhCore core)

Method Detail

serviceName_serviceInfos_GET

public OvhService serviceName_serviceInfos_GET(String serviceName)
                                        throws IOException

Get this object properties REST: GET /paas/database/{serviceName}/serviceInfos

Parameters:

serviceName - [required] Your database project's name API beta

Throws:

IOException

serviceName_serviceInfos_PUT

public void serviceName_serviceInfos_PUT(String serviceName,
                                         OvhService body)
                                  throws IOException

Alter this object properties REST: PUT /paas/database/{serviceName}/serviceInfos

Parameters:

body - [required] New object properties

serviceName - [required] Your database project's name API beta

Throws:

IOException

serviceName_GET

public OvhService serviceName_GET(String serviceName)
                           throws IOException

Get this object properties REST: GET /paas/database/{serviceName}

Parameters:

serviceName - [required] Your database project's name API beta

Throws:

IOException

serviceName_PUT

public void serviceName_PUT(String serviceName,
                            OvhService body)
                     throws IOException

Alter this object properties REST: PUT /paas/database/{serviceName}

Parameters:

body - [required] New object properties

serviceName - [required] Your database project's name API beta

Throws:

IOException

serviceName_dump_GET

public ArrayList<String> serviceName_dump_GET(String serviceName,
                                              Date creationDate,
                                              String databaseName,
                                              Date expirationDate,
                                              String instanceId,
                                              OvhStatus status)
                                       throws IOException

Dumps linked to your project REST: GET /paas/database/{serviceName}/dump

Parameters:

instanceId - [required] Filter the value of instanceId property (=)

creationDate - [required] Filter the value of creationDate property (<)

databaseName - [required] Filter the value of databaseName property (=)

status - [required] Filter the value of status property (=)

expirationDate - [required] Filter the value of expirationDate property (<)

serviceName - [required] Your database project's name API beta

Throws:

IOException

serviceName_dump_dumpId_GET

public OvhDump serviceName_dump_dumpId_GET(String serviceName,
                                           String dumpId)
                                    throws IOException

Get this object properties REST: GET /paas/database/{serviceName}/dump/{dumpId}

Parameters:

serviceName - [required] Your database project's name

dumpId - [required] Dump id API beta

Throws:

IOException

serviceName_dump_dumpId_DELETE

public OvhDump serviceName_dump_dumpId_DELETE(String serviceName,
                                              String dumpId)
                                       throws IOException

Delete the dump REST: DELETE /paas/database/{serviceName}/dump/{dumpId}

Parameters:

serviceName - [required] Your database project's name

dumpId - [required] Dump id API beta

Throws:

IOException

serviceName_dump_dumpId_restore_POST

public OvhDump serviceName_dump_dumpId_restore_POST(String serviceName,
                                                    String dumpId,
                                                    String instanceId,
                                                    String databaseName)
                                             throws IOException

Request the restore from this dump REST: POST /paas/database/{serviceName}/dump/{dumpId}/restore

Parameters:

instanceId - [required] The instanceId where you want to restore this dump

databaseName - [required] The databaseName where you want to restore this dump

serviceName - [required] Your database project's name

dumpId - [required] Dump id API beta

Throws:

IOException

serviceName_task_GET

public ArrayList<String> serviceName_task_GET(String serviceName,
                                              String function,
                                              OvhStatus status)
                                       throws IOException

Tasks linked your project REST: GET /paas/database/{serviceName}/task

Parameters:

function - [required] Filter the value of function property (=)

status - [required] Filter the value of status property (=)

serviceName - [required] Your database project's name API beta

Throws:

IOException

serviceName_task_taskId_GET

public OvhTask serviceName_task_taskId_GET(String serviceName,
                                           String taskId)
                                    throws IOException

Get this object properties REST: GET /paas/database/{serviceName}/task/{taskId}

Parameters:

serviceName - [required] Your database project's name

taskId - [required] Task id API beta

Throws:

IOException

serviceName_instance_GET

public ArrayList<String> serviceName_instance_GET(String serviceName,
                                                  OvhStatus status)
                                           throws IOException

Instances linked to your project REST: GET /paas/database/{serviceName}/instance

Parameters:

status - [required] Filter the value of status property (=)

serviceName - [required] Your database project's name API beta

Throws:

IOException

serviceName_instance_POST

public ArrayList<OvhData> serviceName_instance_POST(String serviceName,
                                                    OvhParameters[] parameters)
                                             throws IOException

Create new instance REST: POST /paas/database/{serviceName}/instance

Parameters:

parameters - [required] Array of instance creation parameters

serviceName - [required] Your database project's name API beta

Throws:

IOException

serviceName_instance_instanceId_restart_POST

public OvhInstance serviceName_instance_instanceId_restart_POST(String serviceName,
                                                                String instanceId)
                                                         throws IOException

Restart the instance REST: POST /paas/database/{serviceName}/instance/{instanceId}/restart

Parameters:

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid API beta

Throws:

IOException

serviceName_instance_instanceId_GET

public OvhInstance serviceName_instance_instanceId_GET(String serviceName,
                                                       String instanceId)
                                                throws IOException

Get this object properties REST: GET /paas/database/{serviceName}/instance/{instanceId}

Parameters:

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid API beta

Throws:

IOException

serviceName_instance_instanceId_PUT

public void serviceName_instance_instanceId_PUT(String serviceName,
                                                String instanceId,
                                                OvhInstance body)
                                         throws IOException

Alter this object properties REST: PUT /paas/database/{serviceName}/instance/{instanceId}

Parameters:

body - [required] New object properties

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid API beta

Throws:

IOException

serviceName_instance_instanceId_DELETE

public OvhInstance serviceName_instance_instanceId_DELETE(String serviceName,
                                                          String instanceId)
                                                   throws IOException

Delete instance REST: DELETE /paas/database/{serviceName}/instance/{instanceId}

Parameters:

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid API beta

Throws:

IOException

serviceName_instance_instanceId_stop_POST

public OvhInstance serviceName_instance_instanceId_stop_POST(String serviceName,
                                                             String instanceId)
                                                      throws IOException

Stop the instance REST: POST /paas/database/{serviceName}/instance/{instanceId}/stop

Parameters:

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid API beta

Throws:

IOException

serviceName_instance_instanceId_whitelist_GET

public ArrayList<String> serviceName_instance_instanceId_whitelist_GET(String serviceName,
                                                                       String instanceId,
                                                                       OvhStatus status)
                                                                throws IOException

The whitelist configuration (used to access to your instance) REST: GET /paas/database/{serviceName}/instance/{instanceId}/whitelist

Parameters:

status - [required] Filter the value of status property (=)

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid API beta

Throws:

IOException

serviceName_instance_instanceId_whitelist_POST

public OvhInstanceWhitelist serviceName_instance_instanceId_whitelist_POST(String serviceName,
                                                                           String instanceId,
                                                                           String ip,
                                                                           String name,
                                                                           Boolean service,
                                                                           Boolean sftp)
                                                                    throws IOException

Create a new IP whitelist REST: POST /paas/database/{serviceName}/instance/{instanceId}/whitelist

Parameters:

ip - [required] The IP to whitelist in your instance

name - [required] Custom name for your Whitelisted IP

service - [required] Authorize this IP to access service port

sftp - [required] Authorize this IP to access sftp port

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid API beta

Throws:

IOException

serviceName_instance_instanceId_whitelist_ip_GET

public OvhInstanceWhitelist serviceName_instance_instanceId_whitelist_ip_GET(String serviceName,
                                                                             String instanceId,
                                                                             String ip)
                                                                      throws IOException

Get this object properties REST: GET /paas/database/{serviceName}/instance/{instanceId}/whitelist/{ip}

Parameters:

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid

ip - [required] The whitelisted IP in your instance API beta

Throws:

IOException

serviceName_instance_instanceId_whitelist_ip_PUT

public void serviceName_instance_instanceId_whitelist_ip_PUT(String serviceName,
                                                             String instanceId,
                                                             String ip,
                                                             OvhInstanceWhitelist body)
                                                      throws IOException

Alter this object properties REST: PUT /paas/database/{serviceName}/instance/{instanceId}/whitelist/{ip}

Parameters:

body - [required] New object properties

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid

ip - [required] The whitelisted IP in your instance API beta

Throws:

IOException

serviceName_instance_instanceId_whitelist_ip_DELETE

public OvhInstanceWhitelist serviceName_instance_instanceId_whitelist_ip_DELETE(String serviceName,
                                                                                String instanceId,
                                                                                String ip)
                                                                         throws IOException

Delete ain IP whitelist REST: DELETE /paas/database/{serviceName}/instance/{instanceId}/whitelist/{ip}

Parameters:

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid

ip - [required] The whitelisted IP in your instance API beta

Throws:

IOException

serviceName_instance_instanceId_database_GET

public ArrayList<String> serviceName_instance_instanceId_database_GET(String serviceName,
                                                                      String instanceId,
                                                                      OvhStatus status)
                                                               throws IOException

Databases available in your instance REST: GET /paas/database/{serviceName}/instance/{instanceId}/database

Parameters:

status - [required] Filter the value of status property (=)

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid API beta

Throws:

IOException

serviceName_instance_instanceId_database_POST

public OvhInstanceDatabase serviceName_instance_instanceId_database_POST(String serviceName,
                                                                         String instanceId,
                                                                         String databaseName)
                                                                  throws IOException

Create a new database on your instance REST: POST /paas/database/{serviceName}/instance/{instanceId}/database

Parameters:

databaseName - [required] Name of your new database

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid API beta

Throws:

IOException

serviceName_instance_instanceId_database_databaseName_GET

public OvhInstanceDatabase serviceName_instance_instanceId_database_databaseName_GET(String serviceName,
                                                                                     String instanceId,
                                                                                     String databaseName)
                                                                              throws IOException

Get this object properties REST: GET /paas/database/{serviceName}/instance/{instanceId}/database/{databaseName}

Parameters:

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid

databaseName - [required] Database name API beta

Throws:

IOException

serviceName_instance_instanceId_database_databaseName_DELETE

public OvhInstanceDatabase serviceName_instance_instanceId_database_databaseName_DELETE(String serviceName,
                                                                                        String instanceId,
                                                                                        String databaseName)
                                                                                 throws IOException

Delete the database REST: DELETE /paas/database/{serviceName}/instance/{instanceId}/database/{databaseName}

Parameters:

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid

databaseName - [required] Database name API beta

Throws:

IOException

serviceName_instance_instanceId_database_databaseName_extension_extensionName_GET

public OvhInstanceDatabaseExtension serviceName_instance_instanceId_database_databaseName_extension_extensionName_GET(String serviceName,
                                                                                                                      String instanceId,
                                                                                                                      String databaseName,
                                                                                                                      String extensionName)
                                                                                                               throws IOException

Get this object properties REST: GET /paas/database/{serviceName}/instance/{instanceId}/database/{databaseName}/extension/{extensionName}

Parameters:

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid

databaseName - [required] Database name

extensionName - [required] Extension name API beta

Throws:

IOException

serviceName_instance_instanceId_database_databaseName_extension_extensionName_enable_POST

public OvhInstanceDatabaseExtension serviceName_instance_instanceId_database_databaseName_extension_extensionName_enable_POST(String serviceName,
                                                                                                                              String instanceId,
                                                                                                                              String databaseName,
                                                                                                                              String extensionName)
                                                                                                                       throws IOException

Enable an extension on a database REST: POST /paas/database/{serviceName}/instance/{instanceId}/database/{databaseName}/extension/{extensionName}/enable

Parameters:

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid

databaseName - [required] Database name

extensionName - [required] Extension name API beta

Throws:

IOException

serviceName_instance_instanceId_database_databaseName_extension_extensionName_disable_POST

public OvhInstanceDatabaseExtension serviceName_instance_instanceId_database_databaseName_extension_extensionName_disable_POST(String serviceName,
                                                                                                                               String instanceId,
                                                                                                                               String databaseName,
                                                                                                                               String extensionName)
                                                                                                                        throws IOException

Disable an extension from a database REST: POST /paas/database/{serviceName}/instance/{instanceId}/database/{databaseName}/extension/{extensionName}/disable

Parameters:

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid

databaseName - [required] Database name

extensionName - [required] Extension name API beta

Throws:

IOException

serviceName_instance_instanceId_database_databaseName_extension_GET

public ArrayList<String> serviceName_instance_instanceId_database_databaseName_extension_GET(String serviceName,
                                                                                             String instanceId,
                                                                                             String databaseName,
                                                                                             String extensionName,
                                                                                             OvhStatus status)
                                                                                      throws IOException

Extensions linked to your database REST: GET /paas/database/{serviceName}/instance/{instanceId}/database/{databaseName}/extension

Parameters:

status - [required] Filter the value of status property (=)

extensionName - [required] Filter the value of extensionName property (like)

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid

databaseName - [required] Database name API beta

Throws:

IOException

serviceName_instance_instanceId_database_databaseName_dump_GET

public ArrayList<String> serviceName_instance_instanceId_database_databaseName_dump_GET(String serviceName,
                                                                                        String instanceId,
                                                                                        String databaseName,
                                                                                        Date creationDate,
                                                                                        Date expirationDate,
                                                                                        OvhStatus status)
                                                                                 throws IOException

Dump available for your database REST: GET /paas/database/{serviceName}/instance/{instanceId}/database/{databaseName}/dump

Parameters:

creationDate - [required] Filter the value of creationDate property (<)

status - [required] Filter the value of status property (=)

expirationDate - [required] Filter the value of expirationDate property (<)

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid

databaseName - [required] Database name API beta

Throws:

IOException

serviceName_instance_instanceId_database_databaseName_dump_POST

public OvhInstanceDatabaseDump serviceName_instance_instanceId_database_databaseName_dump_POST(String serviceName,
                                                                                               String instanceId,
                                                                                               String databaseName,
                                                                                               String email,
                                                                                               String name)
                                                                                        throws IOException

Request the dump of this database REST: POST /paas/database/{serviceName}/instance/{instanceId}/database/{databaseName}/dump

Parameters:

email - [required] Email used when the dump will be available ? ( Default: null, can be nic-adm or nic-tech )

name - [required] A description name for your dump

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid

databaseName - [required] Database name API beta

Throws:

IOException

serviceName_instance_instanceId_database_databaseName_dump_dumpId_GET

public OvhInstanceDatabaseDump serviceName_instance_instanceId_database_databaseName_dump_dumpId_GET(String serviceName,
                                                                                                     String instanceId,
                                                                                                     String databaseName,
                                                                                                     String dumpId)
                                                                                              throws IOException

Get this object properties REST: GET /paas/database/{serviceName}/instance/{instanceId}/database/{databaseName}/dump/{dumpId}

Parameters:

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid

databaseName - [required] Database name

dumpId - [required] Dump id API beta

Throws:

IOException

serviceName_instance_instanceId_database_databaseName_dump_dumpId_DELETE

public OvhInstanceDatabaseDump serviceName_instance_instanceId_database_databaseName_dump_dumpId_DELETE(String serviceName,
                                                                                                        String instanceId,
                                                                                                        String databaseName,
                                                                                                        String dumpId)
                                                                                                 throws IOException

Delete dump before expiration date REST: DELETE /paas/database/{serviceName}/instance/{instanceId}/database/{databaseName}/dump/{dumpId}

Parameters:

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid

databaseName - [required] Database name

dumpId - [required] Dump id API beta

Throws:

IOException

serviceName_instance_instanceId_database_databaseName_dump_dumpId_restore_POST

public OvhInstanceDatabaseDump serviceName_instance_instanceId_database_databaseName_dump_dumpId_restore_POST(String serviceName,
                                                                                                              String instanceId,
                                                                                                              String databaseName,
                                                                                                              String dumpId)
                                                                                                       throws IOException

Request the restore of this dump REST: POST /paas/database/{serviceName}/instance/{instanceId}/database/{databaseName}/dump/{dumpId}/restore

Parameters:

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid

databaseName - [required] Database name

dumpId - [required] Dump id API beta

Throws:

IOException

serviceName_instance_instanceId_resize_POST

public OvhInstance serviceName_instance_instanceId_resize_POST(String serviceName,
                                                               String instanceId,
                                                               String offerName)
                                                        throws IOException

Resize the instance (by migrating the offer) REST: POST /paas/database/{serviceName}/instance/{instanceId}/resize

Parameters:

offerName - [required] Name of the new offer you want to resize your instance to

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid API beta

Throws:

IOException

serviceName_instance_instanceId_changeSftpPassword_POST

public OvhInstance serviceName_instance_instanceId_changeSftpPassword_POST(String serviceName,
                                                                           String instanceId,
                                                                           String password)
                                                                    throws IOException

Change the ftp password of the instance REST: POST /paas/database/{serviceName}/instance/{instanceId}/changeSftpPassword

Parameters:

password - [required] The new password ( alphanumeric, 8 characters minimum and 31 max )

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid API beta

Throws:

IOException

serviceName_instance_instanceId_user_GET

public ArrayList<String> serviceName_instance_instanceId_user_GET(String serviceName,
                                                                  String instanceId,
                                                                  OvhStatus status)
                                                           throws IOException

Users allowed to connect on a databases of an instance REST: GET /paas/database/{serviceName}/instance/{instanceId}/user

Parameters:

status - [required] Filter the value of status property (=)

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid API beta

Throws:

IOException

serviceName_instance_instanceId_user_POST

public OvhInstanceUser serviceName_instance_instanceId_user_POST(String serviceName,
                                                                 String instanceId,
                                                                 String password,
                                                                 String userName)
                                                          throws IOException

Create a new user on your databases REST: POST /paas/database/{serviceName}/instance/{instanceId}/user

Parameters:

password - [required] Password for this new user ( alphanumeric, 8 characters minimum and 31 max )

userName - [required] User name used to connect on your databases

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid API beta

Throws:

IOException

serviceName_instance_instanceId_user_userName_GET

public OvhInstanceUser serviceName_instance_instanceId_user_userName_GET(String serviceName,
                                                                         String instanceId,
                                                                         String userName)
                                                                  throws IOException

Get this object properties REST: GET /paas/database/{serviceName}/instance/{instanceId}/user/{userName}

Parameters:

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid

userName - [required] User name used to connect to your databases API beta

Throws:

IOException

serviceName_instance_instanceId_user_userName_DELETE

public OvhInstanceUser serviceName_instance_instanceId_user_userName_DELETE(String serviceName,
                                                                            String instanceId,
                                                                            String userName)
                                                                     throws IOException

Delete a user REST: DELETE /paas/database/{serviceName}/instance/{instanceId}/user/{userName}

Parameters:

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid

userName - [required] User name used to connect to your databases API beta

Throws:

IOException

serviceName_instance_instanceId_user_userName_changePassword_POST

public OvhInstanceUser serviceName_instance_instanceId_user_userName_changePassword_POST(String serviceName,
                                                                                         String instanceId,
                                                                                         String userName,
                                                                                         String password)
                                                                                  throws IOException

Request a password change for a user REST: POST /paas/database/{serviceName}/instance/{instanceId}/user/{userName}/changePassword

Parameters:

password - [required] The new password ( alphanumeric, 8 characters minimum and 31 max )

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid

userName - [required] User name used to connect to your databases API beta

Throws:

IOException

serviceName_instance_instanceId_upgrade_POST

public OvhInstance serviceName_instance_instanceId_upgrade_POST(String serviceName,
                                                                String instanceId,
                                                                String imageName)
                                                         throws IOException

Upgrade the instance with a new image REST: POST /paas/database/{serviceName}/instance/{instanceId}/upgrade

Parameters:

imageName - [required] Name of the new image that you want for your instance to use

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid API beta

Throws:

IOException

serviceName_instance_instanceId_configuration_GET

public OvhInstanceConfiguration serviceName_instance_instanceId_configuration_GET(String serviceName,
                                                                                  String instanceId)
                                                                           throws IOException

Get this object properties REST: GET /paas/database/{serviceName}/instance/{instanceId}/configuration

Parameters:

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid API beta

Throws:

IOException

serviceName_instance_instanceId_configuration_update_POST

public OvhInstanceConfiguration serviceName_instance_instanceId_configuration_update_POST(String serviceName,
                                                                                          String instanceId,
                                                                                          OvhSafeKeyValue<String>[] parameters)
                                                                                   throws IOException

Update the instance configuration REST: POST /paas/database/{serviceName}/instance/{instanceId}/configuration/update

Parameters:

parameters - [required] Array of instance configuration parameters

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid API beta

Throws:

IOException

serviceName_instance_instanceId_start_POST

public OvhInstance serviceName_instance_instanceId_start_POST(String serviceName,
                                                              String instanceId)
                                                       throws IOException

Start the instance REST: POST /paas/database/{serviceName}/instance/{instanceId}/start

Parameters:

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid API beta

Throws:

IOException

serviceName_instance_instanceId_grant_GET

public ArrayList<String> serviceName_instance_instanceId_grant_GET(String serviceName,
                                                                   String instanceId,
                                                                   OvhStatus status)
                                                            throws IOException

Grants of sql users on your sql databases REST: GET /paas/database/{serviceName}/instance/{instanceId}/grant

Parameters:

status - [required] Filter the value of status property (=)

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid API beta

Throws:

IOException

serviceName_instance_instanceId_grant_POST

public OvhInstanceGrant serviceName_instance_instanceId_grant_POST(String serviceName,
                                                                   String instanceId,
                                                                   String databaseName,
                                                                   OvhType grantType,
                                                                   String userName)
                                                            throws IOException

Add a grant on a database REST: POST /paas/database/{serviceName}/instance/{instanceId}/grant

Parameters:

databaseName - [required] Database's name for this grant

grantType - [required] Grant type

userName - [required] User name to grant

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid API beta

Throws:

IOException

serviceName_instance_instanceId_grant_grantId_GET

public OvhInstanceGrant serviceName_instance_instanceId_grant_grantId_GET(String serviceName,
                                                                          String instanceId,
                                                                          String grantId)
                                                                   throws IOException

Get this object properties REST: GET /paas/database/{serviceName}/instance/{instanceId}/grant/{grantId}

Parameters:

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid

grantId - [required] Grant id API beta

Throws:

IOException

serviceName_instance_instanceId_grant_grantId_PUT

public void serviceName_instance_instanceId_grant_grantId_PUT(String serviceName,
                                                              String instanceId,
                                                              String grantId,
                                                              OvhInstanceGrant body)
                                                       throws IOException

Alter this object properties REST: PUT /paas/database/{serviceName}/instance/{instanceId}/grant/{grantId}

Parameters:

body - [required] New object properties

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid

grantId - [required] Grant id API beta

Throws:

IOException

serviceName_instance_instanceId_grant_grantId_DELETE

public OvhInstanceGrant serviceName_instance_instanceId_grant_grantId_DELETE(String serviceName,
                                                                             String instanceId,
                                                                             String grantId)
                                                                      throws IOException

Delete a grant on a database REST: DELETE /paas/database/{serviceName}/instance/{instanceId}/grant/{grantId}

Parameters:

serviceName - [required] Your database project's name

instanceId - [required] Instance uuid

grantId - [required] Grant id API beta

Throws:

IOException

GET

public ArrayList<String> GET()
                      throws IOException

List available services REST: GET /paas/database API beta

Throws:

IOException

offer_GET

public ArrayList<String> offer_GET(OvhStatus status)
                            throws IOException

Name of all available offers REST: GET /paas/database/offer

Parameters:

status - [required] Filter the value of status property (=) API beta

Throws:

IOException

offer_offerName_GET

public OvhOffer offer_offerName_GET(String offerName)
                             throws IOException

Get this object properties REST: GET /paas/database/offer/{offerName}

Parameters:

offerName - [required] Offer name API beta

Throws:

IOException

region_GET

public ArrayList<String> region_GET(OvhStatus status)
                             throws IOException

Name of all available regions REST: GET /paas/database/region

Parameters:

status - [required] Filter the value of status property (=) API beta

Throws:

IOException

region_regionName_GET

public OvhRegion region_regionName_GET(String regionName)
                                throws IOException

Get this object properties REST: GET /paas/database/region/{regionName}

Parameters:

regionName - [required] Region name API beta

Throws:

IOException

image_GET

public ArrayList<String> image_GET(OvhStatus status,
                                   OvhType type)
                            throws IOException

Name of all available images REST: GET /paas/database/image

Parameters:

status - [required] Filter the value of status property (=)

type - [required] Filter the value of type property (=) API beta

Throws:

IOException

image_imageName_GET

public OvhImage image_imageName_GET(String imageName)
                             throws IOException

Get this object properties REST: GET /paas/database/image/{imageName}

Parameters:

imageName - [required] Image name API beta

Throws:

IOException