H-Sphere Developer Guide

H-Sphere XML API: MySQL Services

 

Related Docs:  

H-Sphere XML API Reference

Actions:

 

Action: addDB

Description: adds database.
* When database is created, H-Sphere adds login name to the end of a new database name. For example, if user 'user1' creates database 'test', it will be named 'test-user1')

Parameters:

    AuthToken:at - authentication information
    String:name - database name
String:description - database description

Response: empty

Example:

<soapenv:Body>
<ns1:addDB soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MySQLServices">
<at href="#id0"/>
<name xsi:type="xsd:string">accounts</name>
<description xsi:type="xsd:string">users_accounts</description>
</ns1:addDB>
<multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:MySQLServices">
<accountId xsi:type="xsd:int">0</accountId>
<login xsi:type="xsd:string">gregin</login>
<password xsi:type="xsd:string">qqqqq</password>
<role xsi:type="ns2:Role" xsi:nil="true"/>
</multiRef>
</soapenv:Body>
...
<soapenv:Body>
<ns1:addDBResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MySQLServices"/>
</soapenv:Body>

 

Action:deleteDB

Description: deletes database.

Parameters:

    AuthToken:at - authentication information
    String:name - database name

Response: empty

Example:

<soapenv:Body>
<ns1:deleteDB soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MySQLServices">
<at href="#id0"/>
<name xsi:type="xsd:string">accounts-gregin</name>
</ns1:deleteDB>
<multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:MySQLServices">
<accountId xsi:type="xsd:int">0</accountId>
<login xsi:type="xsd:string">gregin</login>
<password xsi:type="xsd:string">qqqqq</password>
<role xsi:type="ns2:Role" xsi:nil="true"/>
</multiRef>
</soapenv:Body>
...
<soapenv:Body>
<ns1:deleteDBResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MySQLServices"/>
</soapenv:Body>

 

Action: addUser

Description: adds mysql user.
* When mysql user is created, H-Sphere adds login name to the end of a new mysql username. For example, if user 'user1' creates mysql user 'mysqluser', it will be named 'mysqluser-user1').

Parameters:

    AuthToken:at - authentication information
    String:name - mysql username
    String:password - mysql username password

Response: empty

Example:

<soapenv:Body>
<ns1:addUser soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MySQLServices">
<at href="#id0"/>
<name xsi:type="xsd:string">mysqluser1</name>
<password xsi:type="xsd:string">mypassword</password>
</ns1:addUser>
<multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:MySQLServices">
<accountId xsi:type="xsd:int">0</accountId>
<login xsi:type="xsd:string">gregin</login>
<password xsi:type="xsd:string">qqqqq</password>
<role xsi:type="ns2:Role" xsi:nil="true"/>
</multiRef>
</soapenv:Body>
...
<soapenv:Body>
<ns1:addUserResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MySQLServices"/>
</soapenv:Body>

 

Action: deleteUser

Description: deletes mysqluser.

Parameters:

    AuthToken:at - authentication information
    String:name - mysql username

Response: empty

Example:

<soapenv:Body>
<ns1:deleteUser soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MySQLServices">
<at href="#id0"/>
<name xsi:type="xsd:string">mysqluser1-gregin</name>
</ns1:deleteUser>
<multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:MySQLServices">
<accountId xsi:type="xsd:int">0</accountId>
<login xsi:type="xsd:string">gregin</login>
<password xsi:type="xsd:string">qqqqq</password>
<role xsi:type="ns2:Role" xsi:nil="true"/>
</multiRef>
</soapenv:Body>
...
<soapenv:Body>
<ns1:deleteUserResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MySQLServices"/>
</soapenv:Body>

 

Action: changePassword

Description: changes mysqluser password.

Parameters:

    AuthToken:at - authentication information
    String:name - mysql username
    String:newPassword - mysql username new password

Response: empty

Example:

<soapenv:Body>
<ns1:changePassword soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MySQLServices">
<at href="#id0"/>
<name xsi:type="xsd:string">mysqluser1-gregin</name>
<newPassword xsi:type="xsd:string">newpassword</newPassword>
</ns1:changePassword>
<multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:MySQLServices">
<accountId

xsi:type="xsd:int">0</accountId>
<login xsi:type="xsd:string">gregin</login>
<password xsi:type="xsd:string">qqqqq</password>
<role xsi:type="ns2:Role" xsi:nil="true"/>
</multiRef>
</soapenv:Body>
...
<soapenv:Body>
<ns1:changePasswordResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MySQLServices"/>
</soapenv:Body>

 

Action: changeQuota

Description: changes mysql database quota.

Parameters:

    AuthToken:at - authentication information
    String:name - mysql database name
    double:quota - new mysql database quota

Response: empty

Example:

<soapenv:Body>
<ns1:changeQuota soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MySQLServices">
<at href="#id0"/>
<name xsi:type="xsd:string">accounts-gregin</name>
<quota xsi:type="xsd:double">1.0</quota>
</ns1:changeQuota>
<multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:MySQLServices">
<accountId xsi:type="xsd:int">0</accountId>
<login xsi:type="xsd:string">gregin</login>
<password xsi:type="xsd:string">qqqqq</password>
<role xsi:type="ns2:Role" xsi:nil="true"/>
</multiRef>
</soapenv:Body>
...
<soapenv:Body>
<ns1:changeQuotaResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MySQLServices"/>
</soapenv:Body>

 

Action: setPrivileges

Description: sets mysql user privileges on mysql database.

Parameters:

    AuthToken:at - authentication information
    String:username - mysql user name
    String:dbname - mysql database name

    String[ ]:privileges - array with privileges on dbname for username

Response: empty

Example:

<soapenv:Body>
<ns1:setPrivileges soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MySQLServices">
<at href="#id0"/>
<username xsi:type="xsd:string">newuser-gregin</username>
<dbname xsi:type="xsd:string">accounts-gregin</dbname>
<privileges xsi:type="soapenc:Array" soapenc:arrayType="xsd:anyType[3]" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<item xsi:type="xsd:string">select</item>
<item xsi:type="xsd:string">update</item>
<item xsi:type="xsd:string">delete</item>
</privileges>
</ns1:setPrivileges>
<multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:MySQLServices">
<accountId xsi:type="xsd:int">0</accountId>
<login xsi:type="xsd:string">gregin</login>
<password xsi:type="xsd:string">qqqqq</password>
<role xsi:type="ns2:Role" xsi:nil="true"/>
</multiRef>
</soapenv:Body>
...
<soapenv:Body>
<ns1:setPrivilegesResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MySQLServices"/>
</soapenv:Body>

 

Action: getPrivileges

Description: gets mysql user privileges on mysql database.

Parameters:

    AuthToken:at - authentication information
    String:username - mysql user name
    String:dbname - mysql database name

Response: Object[ ] - array of privileges on dbname for username

Example:

<soapenv:Body>
<ns1:getPrivileges soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MySQLServices">
<at href="#id0"/>
<username xsi:type="xsd:string">newuser-gregin</username>
<dbname xsi:type="xsd:string">accounts-gregin</dbname>
</ns1:getPrivileges>
<multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:AuthToken" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns2="urn:MySQLServices">
<accountId xsi:type="xsd:int">0</accountId>
<login xsi:type="xsd:string">gregin</login>
<password xsi:type="xsd:string">qqqqq</password>
<role xsi:type="ns2:Role" xsi:nil="true"/>
</multiRef>
</soapenv:Body>
...
<soapenv:Body>
<ns1:getPrivilegesResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="MySQLServices">
<getPrivilegesReturn xsi:type="soapenc:Array" soapenc:arrayType="xsd:anyType[3]" xmlns:ns2="http://www.w3.org/2002/12/soap-encoding" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<item xsi:type="xsd:string">update</item>
<item xsi:type="xsd:string">select</item>
<item xsi:type="xsd:string">insert</item>
</getPrivilegesReturn>
</ns1:getPrivilegesResponse>
</soapenv:Body>

 


Related Docs:  

H-Sphere XML API Reference



© Copyright 1998-2006. Positive Software Corporation.
All rights reserved.