MarkLogic 12 Product Documentation
GET /manage/v2/requests

Summary

This resource address returns a summary of the requests 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 either default, or schema.
group-id Specifies to limit the summary information to requests in the specified group. The group can be identified either by id or name.
host-id Specifies to limit the summary information to requests in the specified host. The host can be identified either by id or name.
server-id Specifies to limit the summary information to requests in the specified server. The server can be identified either by id or name.
seconds-min Return only requests that have been executing for at least the specified number of seconds.
fullrefs If set to true, full detail is returned for all relationship references. A value of false (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.

list-summary

Summary for the requests in the list.

This is a complex structure with the following children:

specified-seconds-min

The minimum number of seconds specified to qualify the list of requests or transactions.

max-seconds

The maximum length in seconds for the active requests.

ninetieth-percentile-seconds

The length in seconds for the ninetieth percentile of the active requests.

median-seconds

The median length in seconds for the active requests or the open transactions.

mean-seconds

The mean length in seconds for the active requests or the open transactions.

standard-dev-seconds

The standard deviation in seconds for the active requests or the open transactions.

min-seconds

The minimum length in seconds for the active requests or the open transactions.

total-requests

The total number of active requests.

update-count

The total number of active update requests.

query-count

The total number of active query requests.

list-items

The requests reflected in the summary.

This is a complex structure with the following children:

list-count

The number of requests in the list.

list-item

A request reflected in the 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

The host or server for the request.

uriref

The path for a resource or list of resources.

roleref

A role that distinguishes the resource.

idref

The numeric identifier for the resource.

item-properties

The status properties of the request.

This is a complex structure with the following children:

seconds-elapsed

How long the request has been running.

canceled

Has this request been canceled.

root

The root document directory pathname.

request-kind

The kind of request (for example, invoke, eval).

request-text

The request text.

request-rewritten-text

The rewritten request text.

update

Specifies if this request an update (true for update requests).

start-time

The time the operation started.

time-limit

The request's time limit, in seconds.

max-time-limit

The upper bound for a request's time limit, in seconds.

lock-count

The request's current limit on combined count for the number of times a read or a write lock was acquired.

read-size

The request's current limit on combined size read from disk (listSize+compressedTreeSize), in bytes.

user

The unique ID of the user executing the request.

client-address

The network address of a client

trigger-depth

The maximum depth of trigger invocation.

expanded-tree-cache-hits

The number of hits on the expanded cache.

expanded-tree-cache-misses

The number of misses on the expanded cache.

request-state

The state of a request

profiling-allowed

Is profiling allowed for this request.

profiling-enabled

Is profiling currently enabled for this request.

debugging-allowed

Is debugging allowed for this request.

debugging-status

The debugging status of the request.

retry-count

The number of retries on the request.

expr-id

The expression id.

where-stopped

Where the request is stopped.

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/requests

  ==>  Returns a summary of the requests in the cluster.
Powered by MarkLogic Server | Terms of Use | Privacy Policy