This resource address returns status information for the App Servers 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.
group-id
Specifies to return only the servers in the
specified group. The group can be identified either by id or name.
fullrefs
If set to true, full detail is
returned for all relationship references. A value of false (the default)
indicates to return detail only for first references.
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.
Required Privileges
This operation requires the manage-user role, or the following
privilege:
http://marklogic.com/xdmp/privileges/manage
Usage Notes
The structure of the output returned from
this REST API is as follows:
meta
Properties of the view rather than the resource.
This is a complex structure with the following children:
uri
The path to the view.
current-time
The timestamp for when the view was generated.
elapsed-time
The 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-min
The timestamp for filtering out more recent
requests or transactions.
view-error
An error limiting the data in the view.
This is a complex structure with the following children:
error-type
The kind of error.
error-name
The name of the error.
error-code
The error identifier.
error-message
The error text.
relations
Relationships to resources.
This is a complex structure with the following children:
relation-group
Related resources with the same type.
This is a complex structure with the following children:
uriref
The path for a resource or list of resources.
typeref
The type of a resource or list of resources.
roleref
A role that distinguishes the resource.
relation-count
The number of related resources.
relation
A specific related resource.
This is a complex structure with the following children:
qualifiers
A list of associated resources that distinguish the resource.
This is a complex structure with the following children:
qualifier
Another resource that qualifies the resource.
This is a complex structure with the following children:
uriref
The path for a resource or list of resources.
typeref
The type of a resource or list of resources.
idref
The numeric identifier for the resource.
nameref
The name of the resource.
uriref
The path for a resource or list of resources.
typeref
The type of a resource or list of resources.
roleref
A role that distinguishes the resource.
idref
The numeric identifier for the resource.
nameref
The name of the resource.
status-list-summary
Operating characteristics of the servers in the list.
This is a complex structure with the following children:
request-rate
The rate of a request (requests/sec).
expanded-tree-cache-miss-rate
The average number of misses on the expanded cache.
expanded-tree-cache-hit-rate
The average number of hits on the expanded cache.
request-count
The total number of requests
for a list of servers.
status-list-items
The servers reflected in the status summary.
This is a complex structure with the following children:
status-list-item
A server reflected in the status summary.
This is a complex structure with the following children:
relation
A specific related resource.
This is a complex structure with the following children:
qualifiers
A list of associated resources that distinguish the resource.
This is a complex structure with the following children:
qualifier
Another resource that qualifies the resource.
This is a complex structure with the following children:
uriref
The path for a resource or list of resources.
typeref
The type of a resource or list of resources.
idref
The numeric identifier for the resource.
nameref
The name of the resource.
uriref
The path for a resource or list of resources.
typeref
The type of a resource or list of resources.
roleref
A role that distinguishes the resource.
idref
The numeric identifier for the resource.
nameref
The name of the resource.
relation-id
A group or host related to the server.
groupnameref
uriref
The path for a resource or list of resources.
kindref
The kind of server, which is either
http, task, webDAV, xdbc, or odbc.
content-db
modules-db
roleref
A role that distinguishes the resource.
idref
The numeric identifier for the resource.
nameref
The name of the resource.
related-views
A list of broader or narrower views on the resource or resource type.
This is a complex structure with the following children:
related-view
A broader or narrower view on the resource or resource type.
This is a complex structure with the following children:
view-type
The kind of view.
view-name
The name of the view.
view-uri
The path for the view.
Example
http://localhost:8002/manage/v2/servers?view=status
==> Returns status information for the servers in the cluster.
Stack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.
Stack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.