MAPI Manual

NAME

LIST_DBPS

FUNCTION

List database partitions

SYNOPSIS

action: LIST_DBPS

login_name 
login_passwd 
or 
login_name 
session_id 
or 
device_id 

DESCRIPTION

This function allows account managers to list the database partitions. Both GET and POST methods can be used to perform the request.

Required Parameters
* action: specifies the requested function. Sets to LIST_DBPS.

* login_name: the login name for authenticating the user.
* login_passwd: the login password for authenticating the user.
or
* login_name: the login name for authenticating the user.
* session_id: the session ID for authenticating the user.
or
* device_id: a unique ID of the device. The system can use it as a key to identify users.

RETURN DATA

For each valid request, the server provides a response in XML format.
The response contains the following attributes:
* db_partition_id: the partition ID.
* db_name: name of the database.
* db_user: user of the database.
* db_host_ip: host IP address of the database.
* db_host_port: the port number of the host.
* isactive: specifies whether the partition is active. "1" represents active.
* creat_dt: timestamp when the partition was created.
* note:

For an invalid request, the response XML contains the following attribute:
* msg: a string containing the error message.

ROLE PERMITTED

Account manager, root

EXAMPLES

The following example shows a successful HTTP GET request and response.

Request:
http://app02.yvntech.com/MapIHttpS/MapIS?action=LIST_DBPS&device_id=mydemoid

Response:
<result tftype='1' infotype='0'>
    <resultset name='db_partitions'>
        <row>
            <field name='db_partition_id'>1</field>
            <field name='db_name'>mcpdb</field>
            <field name='db_user'>mcp</field>
            <field name='db_host_ip'>23.23.235.86</field>
            <field name='db_host_port'>44444</field>
            <field name='isactive'>1</field>
            <field name='creat_dt'>2013-05-01 05:55:29</field>
            <field name='note'></field>
        </row>
    </resultset>
</result>

TIPS

ENVIRONMENT

AUTHOR

YVN Tech

SEE ALSO

Mweb v2.0 YVNTECH 2014