MarkLogic 9 Product Documentation
GET /manage/v2/databasesSummary
This resource address returns a summary of the databases in the cluster.
| URL Parameters |
| format |
The format of the returned data. Can be either
html, json, or xml (default). This value overrides
the Accept header if both are present. |
| view |
A specific view of the returned data. Can be
schema, metrics, package, or default.
|
| Request Headers |
| Accept |
The expected MIME type of the response. If the
format parameter is present, it takes precedence over the Accept header. |
| Response Headers |
| Content-type |
The MIME type of the data in the response
body. Depending upon the value of the format parameter or Accept header, one of
application/xml, application/json, or text/html.
|
Response
Upon success, MarkLogic Server returns status code 200 (OK). The response body
contains the requested data.
Usage Notes
The structure of the data in the response for the default view is as follows:
metaProperties of the view rather than the resource.
This is a complex structure with the following children:
uriThe path to the view.
current-timeThe timestamp for when the view was generated.
elapsed-timeThe time required to construct the view. The
elapsed time indicates the relative cost of generating the view. Consider
the cost when determining how frequently to request a view.
start-minThe timestamp for filtering out more recent
requests or transactions.
view-errorAn error limiting the data in the view.
This is a complex structure with the following children:
error-typeThe kind of error.
error-nameThe name of the error.
error-codeThe error identifier.
error-messageThe error text.
relationsRelationships to resources.
This is a complex structure with the following children:
relation-groupRelated resources with the same type.
This is a complex structure with the following children:
urirefThe path for a resource or list of resources.
typerefThe type of a resource or list of resources.
rolerefA role that distinguishes the resource.
relation-countThe number of related resources.
relationA specific related resource.
This is a complex structure with the following children:
qualifiersA list of associated resources that distinguish the resource.
This is a complex structure with the following children:
qualifierAnother resource that qualifies the resource.
This is a complex structure with the following children:
urirefThe path for a resource or list of resources.
typerefThe type of a resource or list of resources.
idrefThe numeric identifier for the resource.
namerefThe name of the resource.
urirefThe path for a resource or list of resources.
typerefThe type of a resource or list of resources.
rolerefA role that distinguishes the resource.
idrefThe numeric identifier for the resource.
namerefThe name of the resource.
list-itemsItems of this resource type.
This is a complex structure with the following children:
list-countThe number of items of this resource type.
list-itemAn item of this resource type.
This is a complex structure with the following children:
urirefThe path for a resource or list of resources.
rolerefA role that distinguishes the resource.
idrefThe numeric identifier for the resource.
namerefThe name of the resource.
item-summary
related-viewsA list of broader or narrower views on the resource or resource type.
This is a complex structure with the following children:
related-viewA broader or narrower view on the resource or resource type.
This is a complex structure with the following children:
view-typeThe kind of view.
view-nameThe name of the view.
view-uriThe path for the view.
Example
http://localhost:8002/manage/v2/databases
==> Returns a list of the databases in the cluster.
Copyright © 2025 MarkLogic Corporation. MARKLOGIC is a
registered trademark of MarkLogic Corporation.