Performs operations like add, remove, update, and list on a database group.
Service | dbgroups |
Permission | DBMS XML API |
Version | 4.4.9 or later |
Parameter | Definition |
|---|---|
HH$Name | The name of the database group |
HH$Action | The action to perform on the database group |
HH$Description | The description of the database group |
HH$NewName | The new name of the database group |
Note
If the HH$Action parameter is not specified, the list action is used as default. Also, if the HH$Name is missing when listing database groups then all the db groups are listed.
Example
Note
The port number mentioned here varies depending on the Database Security configuration.
List all the database groups:
https://127.0.0.1:8443/xmlapi.svc?service=dbgroupsList all the databases that are attached to the db group named: my_dbgroup
https://127.0.0.1:8443/xmlapi.svc?service=dbgroups&HH$Name=my_dbgroupTo add a new database group named: db_group1
https://127.0.0.1:8443/xmlapi.svc?service=dbgroups&HH$Action=add&HH$Name=db_group1&HH$Description=This%20Group%20is%20mineTo delete the database group name: db_group3
https://127.0.0.1:8443/xmlapi.svc?service=dbgroups&HH$Action=delete&HH$Name=db_group3To update the database group name: db_group9 and change the name to a new value: db_group101
https://127.0.0.1:8443/xmlapi.svc?service=dbgroups&HH$Action=update&HH$Name=db_group3&HH$NewName=db_group101
Note
Database group names are unique.