 |
XQUERY/XSLT API DOCUMENTATION
7.0-6
|
 |

W3C XQuery/XSLT Reference
|
|
This page was generated
January 28, 2016
4:08 AM
|
XQuery & XSLT Built-In & Modules Function
Reference
|

Module: Management API
|
|
The Management API is a REST-based API that allows you to administer MarkLogic
Server and access MarkLogic Server instrumentation with no provisioning or
set-up. You can use the API to perform administrative tasks
such as initializing or extending a cluster; creating databases, forests, and
App Servers; and managing tiered storage partitions. The API also provides
the ability to easily capture detailed information on MarkLogic Server
objects and processes, such as hosts, databases, forests,
App Servers, groups, transactions, and requests from a wide variety of tools.
All of the resource addresses in the Management API require the
http://marklogic.com/xdmp/privileges/manage privilege.
Methods that modify configuration also require the privilege
http://marklogic.com/xdmp/privileges/manage-admin. See
the individual methods for detils.
If a request results in an error, the body of the response includes
error details. The MIME type of error details is determined by the
format request parameter (where supported), Accept
header, or request Content-type header, in that order of precedence.
For example, if a request supplies XML input (request Content-type
set to application/xml), but specifies JSON output using
the format parameter, then error details are returned as
JSON. The default error detail MIME type is XML.
|
|
|
REST Resource Summary
|
|
POST /admin/v1/cluster-config
|
Provide host or cluster configuration information suitable for
adding a new host to an existing cluster.
|
|
DELETE /admin/v1/host-config
|
Remove a host's configuration from the cluster configuration, dropping
the host from the cluster.
|
|
POST /admin/v1/init
|
Initialize MarkLogic Server, optionally installing or updating an
license key at the same time; or install/update a license key for a
previously initialized instance of MarkLogic Server.
|
|
POST /admin/v1/instance-admin
|
Install the admin username and password, and initialize the security
database and objects.
|
|
GET /admin/v1/server-config
|
Retrieve MarkLogic Server configuration information, suitable for
use in joining a cluster.
|
|
GET /admin/v1/timestamp
|
Verify that MarkLogic Server is up and accepting requests.
|
|
HEAD /admin/v1/timestamp
|
Verify that MarkLogic Server is up and accepting requests.
|
|
GET /manage/v2?view=query
|
This resource address returns the summary of all of the resources
in the local cluster, or resources in the local cluster that
match a query.
|
|
GET /manage/v2?view=status
|
This resource address returns a status summary for the local cluster.
|
|
GET /manage/v2/
|
This resource address returns summary information for the local cluster.
|
|
GET /manage/v2/clusters
|
This resource address returns a list of all of the clusters coupled to the
local cluster.
|
|
GET /manage/v2/clusters?view=metrics
|
Retrieve historical monitoring data for the clusters coupled to the
local cluster.
|
|
GET /manage/v2/clusters/{id|name}
|
This resource address returns summary information for the specified
foreign cluster.
|
|
POST /manage/v2/clusters/{id|name}
|
Initiate a state change on the named cluster, such as a shutdown or restart.
|
|
GET /manage/v2/clusters/{id|name}?view=config
|
Retrieve configuration information for the named foreign cluster.
|
|
GET /manage/v2/clusters/{id|name}?view=metrics
|
Retrieve historical monitoring data for the specified cluster.
|
|
GET /manage/v2/clusters/{id|name}?view=status
|
This resource address returns a status summary for the specified
foreign cluster.
|
|
GET /manage/v2/databases
|
This resource address returns a summary of the databases in the cluster.
|
|
GET /manage/v2/databases?view=metrics
|
Retrieve historical monitoring data about the databases in the cluster.
|
|
GET /manage/v2/databases/{id|name}
|
This resource address returns information on the specified database.
|
|
GET /manage/v2/databases/{id|name}?view=config
|
This resource address returns configuration information for the named
database.
|
|
GET /manage/v2/databases/{id|name}?view=counts
|
This resource address returns the count information for forests attached
to the named database.
|
|
GET /manage/v2/databases/{id|name}?view=package
|
This resource address returns configuration details about the named
database in a format suitable for use with the
/manage/v2/packages interfaces.
|
|
GET /manage/v2/databases/{id|name}?view=status
|
This resource address returns status information for the named
database.
|
|
GET /manage/v2/databases/{id|name}/{custom}
|
This resource address returns some custom information for the specified database, as
implemented by a specific plugin.
|
|
GET /manage/v2/databases/{id|name}/partitions
|
Retrieve a list of partitions in a database.
|
|
POST /manage/v2/databases/{id|name}/partitions
|
Add a partition to the database.
|
|
DELETE /manage/v2/databases/{id|name}/partitions/{name}
|
Delete the partition identified by {name} from the database
identified by {id|name}.
|
|
GET /manage/v2/databases/{id|name}/partitions/{name}
|
Retrieve a partition summary that includes links to related resources,
such as the containing database, member forests, and the partition
configuration.
|
|
PUT /manage/v2/databases/{id|name}/partitions/{name}
|
Invoke an operation on a partition, such as resizing the partition or
transferring or migrating the partition to a different database.
|
|
GET /manage/v2/databases/{id|name}/partitions/{name}/properties
|
Retrieve the current configuration for the partition identified by
{name} in the database identified by {name|id}.
|
|
PUT /manage/v2/databases/{id|name}/partitions/{name}/properties
|
Modify the configuration of the partition identified by {name}
in the database identified by {id|name}.
|
|
GET /manage/v2/databases/{id|name}/rebalancer
|
This resource address returns the current rebalancer configuration.
|
|
PUT /manage/v2/databases/{id|name}/rebalancer
|
Update the rebalancer configuration for a database.
|
|
GET /manage/v2/databases/{id|name}/sub-databases
|
Retrieve a list of sub-databases of the database identified by
{id|name}.
|
|
POST /manage/v2/databases/{id|name}/sub-databases
|
Create a new database attached as sub-database of the database identified
by {id|name}.
|
|
GET /manage/v2/databases/{id|name}/super-databases
|
Retrieve a list of super-databases of which the specified database
is a sub-database.
|
|
POST /manage/v2/databases/{id|name}/super-databases
|
Create a new database and make it a super-database of the database
identified by {id|name}.
|
|
DELETE /manage/v2/databases/{sub-id|name}/super-databases/{super-id|name}
|
Disassociate a super-database from a sub-database and delete the
super-database.
|
|
GET /manage/v2/databases/{sub-id|name}/super-databases/{super-id|name}
|
Retrieve a summary about a specific super-database of a sub-database.
|
|
DELETE /manage/v2/databases/{super-id|name}/sub-databases/{sub-id|name}
|
Disassociate a sub-database from a super-database and delete the
sub-database.
|
|
GET /manage/v2/databases/{super-id|name}/sub-databases/{sub-id|name}
|
Retrieve a summary of the specified sub-database, including a list of
sibling sub-databases, if any.
|
|
GET /manage/v2/forests
|
This resource address returns data about the forests in the cluster.
|
|
POST /manage/v2/forests
|
Create a new forest, including replicas if specified.
|
|
PUT /manage/v2/forests
|
Perform an operation on one or more forests, such as combining
multiple forests into a single new one, or migrating the data in the
forests to a new data directory.
|
|
GET /manage/v2/forests?view=metrics
|
Retrieve historical monitoring data about the forests in the cluster.
|
|
GET /manage/v2/forests?view=status
|
This resource address returns status information about the forests
in the cluster.
|
|
GET /manage/v2/forests?view=storage
|
This resource address returns storage information about the forests
in the cluster.
|
|
DELETE /manage/v2/forests/{id|name}
|
Delete a forest.
|
|
GET /manage/v2/forests/{id|name}
|
Retrieve information about a forest.
|
|
POST /manage/v2/forests/{id|name}
|
Initiate a state change on a forest, such as a merge, restart, or attach.
|
|
GET /manage/v2/forests/{id|name}?view=config
|
Retrieve configuration information about the named forest.
|
|
GET /manage/v2/forests/{id|name}?view=counts
|
Retrieve count information about a forest.
|
|
GET /manage/v2/forests/{id|name}?view=status
|
Retrieve status information about the named forest.
|
|
GET /manage/v2/forests/{id|name}/{custom}
|
This resource address returns some custom information for the specified
forest, as implemented by a specific plugin.
|
|
GET /manage/v2/forests/{id|name}/properties
|
Retrieve the current state of modifiable properties of the forest
identified by {id|name}.
|
|
PUT /manage/v2/forests/{id|name}/properties
|
Modify the configuration of the forest identified by {id|name}.
|
|
GET /manage/v2/groups
|
This resource address returns a summary of the groups in the cluster.
|
|
GET /manage/v2/groups/{id|name}
|
This resource address returns information on the specified group.
|
|
GET /manage/v2/groups/{id|name}?view=config
|
This resource address returns configuration information on the
specified group.
|
|
GET /manage/v2/groups/{id|name}?view=counts
|
This resource address returns counts information on the specified group.
|
|
GET /manage/v2/groups/{id|name}?view=status
|
This resource address returns status information on the
specified group.
|
|
GET /manage/v2/hosts
|
Retrieve information about the hosts in a cluster.
|
|
GET /manage/v2/hosts?view=metrics
|
Retrieve historical monitoring data about the hosts in the cluster.
|
|
GET /manage/v2/hosts?view=status
|
Retrieve status information about the hosts in the cluster.
|
|
GET /manage/v2/hosts/{id|name}
|
This resource address returns information on a specific host.
|
|
POST /manage/v2/hosts/{id|name}
|
Initiate a state change on a host, such as a shutdown or restart.
|
|
GET /manage/v2/hosts/{id|name}?view=config
|
This resource address returns configuration information on a specific host.
|
|
GET /manage/v2/hosts/{id|name}?view=counts
|
This resource address returns counts information on a specific host.
|
|
GET /manage/v2/hosts/{id|name}?view=status
|
This resource address returns status information on a specific host.
|
|
GET /manage/v2/hosts/{id|name}/{custom}
|
This resource address returns some custom information for the specified host, as
implemented by a specific plugin.
|
|
GET /manage/v2/hosts/{id|name}/properties
|
This resource address returns the current state of modifiable properties
of the specified host.
|
|
PUT /manage/v2/hosts/{id|name}/properties
|
Initiate a properties change on the specified host.
|
|
GET /manage/v2/meters/labels
|
This resource address returns all of the labels stored for the monitoring history
timespans.
|
|
OPTIONS /manage/v2/meters/labels
|
This resource address returns information on the
/manage/v2/meters/labels endpoint.
|
|
POST /manage/v2/meters/labels
|
This resource address creates a label and returns the ID of the created label.
|
|
DELETE /manage/v2/meters/labels/{id|name}
|
This resource address deletes the named label.
|
|
GET /manage/v2/meters/labels/{id|name}
|
This resource address returns the named label stored for the monitoring history
timespans.
|
|
HEAD /manage/v2/meters/labels/{id|name}
|
This resource address tests to see if the named label is in MarkLogic Server.
|
|
OPTIONS /manage/v2/meters/labels/{id|name}
|
This resource address returns information on the
/manage/v2/meters/labels/{id|name} endpoint.
|
|
PUT /manage/v2/meters/labels/{id|name}
|
This resource address updates an exiting label and returns the ID of the
updated label.
|
|
GET /manage/v2/meters/resources
|
This resource address returns a list of all of the resources in the local cluster
that existed in specified time period..
|
|
GET /manage/v2/requests
|
This resource address returns a summary of the requests in the cluster.
|
|
GET /manage/v2/requests/{id|uri}
|
This resource address returns information on the specified request.
|
|
GET /manage/v2/servers
|
This resource address returns data about the App Servers in the
cluster.
|
|
GET /manage/v2/servers?view=metrics
|
Retrieve historical monitoring data about the App Servers in the cluster.
|
|
GET /manage/v2/servers?view=status
|
This resource address returns status information for the App Servers in the
cluster.
|
|
GET /manage/v2/servers/{id|name}
|
This resource address returns data about a specific App Server.
|
|
GET /manage/v2/servers/{id|name}?view=config
|
This resource address returns configuration data about a specific App Server.
|
|
GET /manage/v2/servers/{id|name}?view=package
|
This resource address returns configuration details about the named
App Server in a format suitable for use with the
/manage/v2/packages interfaces.
|
|
GET /manage/v2/servers/{id|name}?view=status
|
This resource address returns status information about a specific App Server.
|
|
GET /manage/v2/servers/{id|name}/{custom}
|
This resource address returns some custom information for the specified
server, as implemented by a specific plugin.
|
|
GET /manage/v2/tickets/{tid}?view=process-status
|
Check the status of the ticket identified by {tid}.
|
|
GET /manage/v2/transactions
|
This resource address returns a summary of the transactions in the cluster.
|
|
GET /manage/v2/transactions/{id|uri}
|
This resource address returns information on the specified transaction.
|
|
 |
|
REST Resource Detail
|
|
|
POST /admin/v1/cluster-config
|
|
 |
Summary:
Provide host or cluster configuration information suitable for
adding a new host to an existing cluster.
|
Parameters:
server-config?
:
The server configuration of a new host to be joined to this cluster.
This parameter must be supplied as form data in the request body,
and its value should be the output of a previous call to
GET /admin/v1/server-config.
|
group?
:
The group of the new host. Supply this parameter as form data in
the request body. Required with the
server-config request parameter, not permitted otherwise.
|
zone?
:
Optional text describing the location of the new host, such as the
name of an Amazon EC2 Availability Zone. Used by the Tiered Storage
API to configure local disk failover. For details, see
'Tiered Storage' in the Administrator's Guide.
You can only use this parameter when the server-config
request parameter is present.
|
|
Request Headers:
Content-type:
The MIME type of the data in the request body. Must be
x-www-form-urlencoded when the server-config
parameter is present. Must be application/zip when
server-config is not present.
|
|
Response Headers:
Content-type:
The MIME type of the data in the response body. The response data
is always application/xml.
|
|
Required Privilege:
This operation requires the manage-admin role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage-admin
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK) or
202 (Restart). Status 200 indicates no restart is required. The data
in the response body depends on the context in which the request
is made. For details, see the Usage notes.
If license key installation and basic initialization have not yet been
done, the response payload will include a timestamp, but all other
elements will be empty.
|
Usage Notes:
This request must be directed to the MarkLogic Server Admin Interface
on port 8001. For example:
http://localhost:8001/admin/v1/cluster-config.
This method is intended for use in the context of other REST Management
API methods during cluster configuration. Any server-config
input data should be obtained by a previous call to
GET /admin/v1/server-config. Any cluster configuration data
should be obtained by a previous call to
POST /admin/v1/cluster-config. See the example for
the full sequence of calls.
If you include the server-config request parameter, its
value must be a server configuration from a host joining the cluster,
and the request must be directed to a fully initialized host that is
already a member of the cluster. In this case, MarkLogic Server
verifies that security is initialized and responds with cluster
configuration data that can be supplied to the new host in
order to complete the cluster join operation. The input server
configuration must be URL encoded. The data in the response body is
the cluster configuration information in ZIP format.
If you do not include the server-config request parameter,
this request must be sent to the host that is joining a cluster, and the
POST body must contain cluster configuration data in ZIP format, obtained
by a previous call to POST /admin/v1/cluster-config with the
server-config parameter. In this case, MarkLogic Server
verifies this host to be a new host (not already a member of the cluster
and security has not been initialized), and then installs the supplied
cluster configuration to complete the cluster join sequence. The
joining host is restarted.
For details and a complete example, see
'Scripting Cluster Management' in the Scripting Administrative Tasks Guide.
|
Example:
$ curl --anyauth --user admin:password -X POST -d "group=Default" \
--data-urlencode "server-config@./server-config.xml" \
-H "Content-type: application/x-www-form-urlencoded" \
-o ./cluster-config.zip http://cluster-host:8001/admin/v1/cluster-config
==> Retrieve the configuration of the bootstrap host for a cluster and save it
to the file server-config.xml. MarkLogic Server responds with status 200
and a ZIP file containing the cluster configuration data to provide to the
local host in order to complete the cluster join sequence.
|
Example:
$ curl --anyauth --user admin:password -X POST \
-d "group=Default" --data-binary @./cluster-config.zip \
-H "Content-type: application/zip" \
http://joining-host:8001/admin/v1/cluster-config
==> Send the cluster configuration ZIP file obtained by a previous
call to /admin/v1/cluster-config?server-config to a new host
to complete the cluster join sequence. MarkLogic Server responds
with status code 202. A restart occurs.
|
Example:
Use in the following sequence to add a host to a cluster, assuming
clusterhost is a previously fully initialized bootstrap host for
the cluster and joining-host is the host to be initialized and added to
the cluster:
(1) Initialize the new host. For details, see POST /admin/v1/init.
Use GET /admin/v1/timestamp to verify a successful restart.
For details, see POST /admin/v1/init.
$ curl -X POST -d "" -i http://joining-host:8001/admin/v1/init
$ curl -X GET http://joining-host:8001/admin/v1/timestamp
(2) Retrieve the configuration of the joining host, to be used as the
value of the server-config param to POST /admin/v1/cluster-config.
For details, see POST /admin/v1/server-config.
$ curl -o joiner-config.xml -X GET -H "Accept: application/xml" \
http://joining-host:8001/admin/v1/server-config
==> The configuration for joining-host is saved to joiner-config.xml.
See the previous example for the output details.
(3) Send the joining host's URL encoded config info to the bootstrap host.
Receive the cluster configuration in return.
$ curl --anyauth --user user:password -X POST -d "group=Default" \
--data-urlencode "server-config@./joiner-config.xml" \
-H "Content-type: application/x-www-form-urlencoded" \
-o cluster-config.zip http://clusterhost:8001/admin/v1/cluster-config
==> The cluster configuration data is saved in cluster-config.zip.
(4) Send the cluster configuration ZIP file to the joining host to
complete the cluster join sequence. Bracket the POST with calls
to GET /admin/v1/timestamp to confirm a successful restart.
$ curl -X GET http://joining-host:8001/admin/v1/timestamp
$ curl -X POST -H "Content-type: application/zip" \
--data-binary @./cluster-config.zip \
http://joining-host:8001/admin/v1/cluster-config
$ curl --anyauth --user user:password -X GET \
http://joining-host:8001/admin/v1/timestamp
==> The joining host becomes a functional member of the cluster.
|
|
|
|
DELETE /admin/v1/host-config
|
|
 |
Summary:
Remove a host's configuration from the cluster configuration, dropping
the host from the cluster. The remote-host parameter is required
if you are removing a host from a different group.
|
Parameters:
remote-host?
:
Request a host in a cluster to remove the host referenced by this
parameter. To request a host to remove itself, omit this parameter.
The hostname must be resolvable on the host that receives the request.
The remote host can be in any group in the cluster.
|
|
Required Privilege:
This operation requires the manage-admin role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage-admin
|
Response:
If you request a host to remove itself, MarkLogic Server returns status
code 202 (Accepted) and the data in the response body includes the
timestamp of the last restart and a link to the timestamp endpoint.
If you request one host to remove another (by using the
remote-host request parameter), MarkLogic Server returns
status code 204 (No Content).
If the pre-requistes described in the Usage Notes are not met,
MarkLogic Server returns status code 400 with a detailed error
message specifying which pre-requisites are not met.
|
Usage Notes:
This request must be directed to the MarkLogic Server Admin Interface
on port 8001. For example:
http://localhost:8001/admin/v1/host-config.
The host being removed from the cluster must meet the following criteria
for the removal request to be accepted:
- The host must not be a bootstrap host for database replication.
- The host must not have any forests configured.
- The host must not serve as a failover host for shared disk failover.
If and only if the above criteria are met, the host is removed from the
cluster. You can remove a host either by requesting it to remove itself
or by requesting another host to remove it, using remote-host.
The preferred method is to request a host to remove itself by sending
a DELETE request directly to it. This results in a clean, but
uninitialized standalone MarkLogic host and a functioning cluster.
If you request one host in the cluster to remove another (by specifying
the host to be removed using remote-host), the result is
a function cluster, but the removed host is no longer a viable
MarkLogic Server instance. If the removed host is still live, it will
continue to try to communicate with the cluster until it is shut down.
This method is best used to drop a dead host from a cluster or when the
departing host will be shut down immediately.
|
Example:
$ curl --anyauth --user user:password -X DELETE -i \
http://departing-host:8001/admin/v1/host-config
==> Request a host to leave the cluster, resulting in a restart.
This is the preferred way to remove a host from a cluster.
MarkLogic Server sends a response similar to the following. Use the
Location header or the restart/link/uriref to detect when the
restart is complete.
HTTP/1.1 202 Accepted
Content-type: application/xml
Location: /admin/v1/timestamp
Server: MarkLogic
Content-Length: 260
Connection: Keep-Alive
Keep-Alive: timeout=5
<restart xmlns="http://marklogic.com/manage">
<last-startup host-id="13544732455686476949">
2013-05-15T09:01:43.019261-07:00
</last-startup>
<link>
<kindref>timestamp</kindref>
<uriref>/admin/v1/timestamp</uriref>
</link>
<message>Check for new timestamp to verify host restart.</message>
</restart>
|
Example:
$ curl --anyauth --user user:password -X DELETE -i \
http://cluster-host:8001/admin/v1/host-config?remote-host=departing-host
==> Request one host to remove another from a cluster. The departing
host is not restarted and is not a viable instance. MarkLogic Server
responds with status code 204 (No Content).
HTTP/1.1 204 No Content
Server: MarkLogic
Content-Length: 0
Connection: Keep-Alive
Keep-Alive: timeout=5
|
|
|
|
|
 |
Summary:
Initialize MarkLogic Server, optionally installing or updating an
license key at the same time; or install/update a license key for a
previously initialized instance of MarkLogic Server.
|
Parameters:
format?
:
The expected format of the data in the response body. Allowed values:
json or xml. If present, this parameter
overrides the Accept header.
|
license-key?
:
A valid license key. You can only pass this parameter as form
data in the request body. You can also supply a license key in
an XML or JSON payload; for details, see the Usage notes. This
parameter is optional.
|
licensee?
:
The authorized licensee of the key given in license-key.
You can only pass this parameter as form data in the request body. You
can also supply a license key in an XML or JSON payload; for details,
see the Usage notes. This parameter is optional.
|
|
Request Headers:
Accept*:
The expected MIME type of the response. If the format
parameter is present, it takes precedence over the Accept header.
Only application/xml and application/json are
supported.
|
Content-type*:
The MIME type of the data in the request body, if any. Should be
one of application/xml, application/json,
or application/x-www-form-urlencoded.
|
|
Response Headers:
Content-type*:
The MIME type of the data in the response body. Use the Accept header
or format request parameter to specify a preferred format.
The format parameter takes precedence over the Accept
header if both are present.
|
Location:
If the request causes a restart, a Location header is included in the
reponse. The header contains a path with which to construct a URL to
usable to test when the restart has completed.
|
|
Response:
Upon success, if a server restart was required, MarkLogic Server
returns status code 202 (Accepted) and the response body includes
a timestamp and a link to the timestamp service that can be used
to detect when the server restart completes.
If the request succeeds and did not result in a restart, MarkLogic
Server returns status code 204 (Modified Content), and there is no
response body.
If you include a license and the license is invalid, MarkLogic Server
returns status code 400 and the response body includes a descriptive
error message.
|
Usage Notes:
This request must be directed to the MarkLogic Server Admin Interface
on port 8001. For example: http://localhost:8001/admin/v1/init.
This method initializes a MarkLogic Server instance. It must be the
first call you make in setting up a MarkLogic Server instance. The
instance is not fully initialized until you call either POST
/admin/v1/instance-admin or complete the cluster join sequence
discussed under POST /admin/v1/cluster-config.
For details and a complete example, see
'Scripting Cluster Management' in the Scripting Administrative Tasks Guide.
If the request includes license information, the license is installed
or updated. If MarkLogic Server has already been initialized, this
method simply updates license information, if any is included.
You can supply the license key and licensee using either XML, JSON
or form data. If you choose form data, you must set the Content-type
header to application/x-www-form-urlencoded. If you choose
XML or JSON, set the Content-type header to application/xml
or application/json, respectively. Use one of the following
templates for the response body:
XML:
<init xmlns="http://marklogic.com/manage">
<license-key>license key</license-key>
<licensee>licensee</licensee>
</init>
JSON:
{
"license-key" : "license-key",
"licensee" : "licensee"
}
Form Data:
license-key=url-encoded-key&licensee=url-encoded-licensee
This method causes a server restart if MarkLogic Server has not yet been
initialized or if the new license key enables features that require a
restart to enable.
|
Example:
Initialization without installing a license:
$ curl --anyauth -X POST -d "" -i http://localhost:8001/admin/v1/init
==> If the request is sucessful and causes a restart, MarkLogic Server
sends a response similar to the following. You can use the Location
header or the restart/link/uriref to detect when the restart is complete.
HTTP/1.1 202 Accepted
Content-type: application/xml
Location: /admin/v1/timestamp
Server: MarkLogic
Content-Length: 260
Connection: Keep-Alive
Keep-Alive: timeout=5
<restart xmlns="http://marklogic.com/manage">
<last-startup host-id="13544732455686476949">
2013-05-15T09:01:43.019261-07:00
</last-startup>
<link>
<kindref>timestamp</kindref>
<uriref>/admin/v1/timestamp</uriref>
</link>
<message>Check for new timestamp to verify host restart.</message>
</restart>
|
Example:
Initialization, including installing a license saved in a file:
$ cat init.xml
<init xmlns="http://marklogic.com/manage">
<license-key>1234-5678-90AB</license-key>
<licensee>Your Licensee</licensee>
</init>
$ curl --anyauth -X POST -d @./init.xml -i -H "Content-type=application/xml" \
http://localhost:8001/admin/v1/init
==> If the request is sucessful and causes a restart, MarkLogic Server
sends a response similar to the following. You can use the Location
header or the restart/link/uriref to detect when the restart is complete.
HTTP/1.1 202 Accepted
Content-type: application/xml
Location: /admin/v1/timestamp
Server: MarkLogic
Content-Length: 260
Connection: Keep-Alive
Keep-Alive: timeout=5
<restart xmlns="http://marklogic.com/manage">
<last-startup host-id="13544732455686476949">
2013-05-15T09:01:43.019261-07:00
</last-startup>
<link>
<kindref>timestamp</kindref>
<uriref>/admin/v1/timestamp</uriref>
</link>
<message>Check for new timestamp to verify host restart.</message>
</restart>
==> If the request did not cause a restart, MarkLogic Server responds
with headers similar to the following:
HTTP/1.1 204 No Content
Server: MarkLogic
Content-Length: 0
Connection: Keep-Alive
Keep-Alive: timeout=5
==> If the license is invalid, MarkLogic Server responds with
headers and a response body similar to the following:
HTTP/1.1 400 Bad Request
Content-type: application/xml
Server: MarkLogic
Content-Length: 203
Connection: Keep-Alive
Keep-Alive: timeout=5
<error xmlns="http://marklogic.com/manage">
<status-code>400</status-code>
<status>Bad Request</status>
<message-code/>
<message>You must enter a key</message>
</error>
|
Example:
Initialization, including a license passed in as form data:
$ curl --anyauth -i -X POST \
-H "Content-type=application/x-www-form-urlencoded" \
--data-urlencode "license-key=1234-5678-90AB" \
--data-urlencode "licensee=Your Licensee" \
http://localhost:8001/admin/v1/init
==> If it has not previously been initialized, MarkLogic Server is
initialized. The supplied license is installed, updating any
previously installed license. Upon success, MarkLogic Server
sends a response similar to the following. Use the Location header
or the restart/link/uriref to detect when the restart is complete.
HTTP/1.1 202 Accepted
Content-type: application/xml
Location: /admin/v1/timestamp
Server: MarkLogic
Content-Length: 313
Connection: Keep-Alive
Keep-Alive: timeout=5
<restart xmlns="http://marklogic.com/manage">
<last-startup host-id="13204257035615066601">
2013-10-17T15:12:28.21886-07:00
</last-startup>
<link>
<kindref>timestamp</kindref>
<uriref>/admin/v1/timestamp</uriref>
</link>
<message>Check for new timestamp to verify host restart.</message>
</restart>
|
|
|
|
POST /admin/v1/instance-admin
|
|
 |
Summary:
Install the admin username and password, and initialize the security
database and objects.
|
Parameters:
format?
:
The format of the data in the response body. Allowed values:
json or xml. If present, this parameter
overrides the Accept header.
|
admin-username?
:
The user name to be configured as the admin user. You can only pass
this parameter as form data in the request body, but you can also
supply this data in an XML or JSON payload. For details, see the
Usage notes.
|
admin-password?
:
The password to be configured as the admin user. You can only pass
this parameter as form data in the request body, but you can also
supply this data in an XML or JSON payload. For details, see the
Usage notes.
|
|
Request Headers:
Accept*:
The expected MIME type of the response. If the format
parameter is present, it takes precedence over the Accept header.
Only application/xml and application/json are
supported.
|
Content-type*:
The MIME type of the data in the request body, if any. Allowed values:
application/xml, application/json,
or application/x-www-form-urlencoded. The format
request parameter takes precedence over this header if present.
|
|
Response Headers:
Content-type*:
The MIME type of the data in the response body. Use the Accept header
or format request parameter to specify a preferred format.
The format parameter takes precedence over the requesAccept
header if both are present.
|
|
Response:
Upon success, MarkLogic Server returns status code 202 (Accepted) and
the response body contains a timestamp and a link to the timestamp
service. Use this information to detect when the server restart completes.
|
Usage Notes:
This request must be directed to the MarkLogic Server Admin Interface
on port 8001. For example:
http://localhost:8001/admin/v1/instance-admin.
You must call POST /admin/v1/init or otherwise initialize
MarkLogic Server prior to using this method.
You should only call this method on a standalone host (not intended
to be part of a cluster), or the initial bootstrap host of a cluster.
Do not use this method on additional hosts in a cluster. Instead, use
the cluster join sequence shown in POST /admin/v1/cluster-config.
You can supply the admin user name and password using either XML, JSON
or form data. If you choose form data, you must set the Content-type
header to application/x-www-form-urlencoded If you choose
XML or JSON, you can specify the content type using either the
format request parameter or the Content-type header.
Use the following templates for the POST body; admin-username
and admin-password are the only required settings.
XML:
<instance-admin xmlns="http://marklogic.com/manage">
<admin-password>your-admin-username</admin-password>
<admin-username>your-admin-password</admin-username>
<realm>public</realm>
</instance-admin>
JSON:
{ "admin-username" : "your-admin-username",
"admin-password" : "your-admin-password",
"realm" : "public"
}
Form Data (must be URL encoded):
admin-user=your-admin-username&admin-password=your-admin-password
If successful, this method causes MarkLogic Server to restart.
You can use the timestamp and the link to the timestamp service to poll
the status of the restart. For details, see
GET /admin/v1/timestamp.
For details and a complete example, see
'Setting Up the First Host in a Cluster' in the Scripting Administrative Tasks Guide.
|
Example:
$ curl -i -X POST \
--data "admin-username=adminuser&admin-password=mypassword" \
http://localhost:8001/admin/v1/instance-admin
==> MarkLogic Server responds with headers and a response body similar
to the following:
HTTP/1.1 202 Accepted
Content-type: application/xml
Location: /admin/v1/timestamp
...
<restart xmlns="http://marklogic.com/manage">
<last-startup host-id="13544732455686476949">
2013-04-01T10:35:19.09913-07:00
</last-startup>
<link>
<kindref>timestamp</kindref>
<uriref>/admin/v1/timestamp</uriref>
</link>
<message>Check for new timestamp to verify host restart.</message>
</restart>
|
|
|
|
GET /admin/v1/server-config
|
|
 |
Summary:
Retrieve MarkLogic Server configuration information, suitable for
use in joining a cluster.
|
Response Headers:
Content-type:
The MIME type of the data in the response body. The response MIME type
is always application/xml.
|
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK) and the
response body contains the requested information, expressed as XML.
If license key installation and basic initialization have not yet been
done, the response payload will include a timestamp, but all other
elements will be empty.
|
Usage Notes:
This request must be directed to the MarkLogic Server Admin Interface
on port 8001. For example:
http://localhost:8001/admin/v1/server-config.
This method is intended for use in the context of other REST Management
API methods during cluster configuration, such as using the data
returned by this request as input to a POST request to
/admin/v1/cluster-config. For the expected sequence, see
the examples below.
For details and a complete example, see
'Scripting Cluster Management' in the Scripting Administrative Tasks Guide.
|
Example:
$ curl --anyauth --user user:password -X GET -H "Accept: application/xml" \
http://my-host:8001/admin/v1/server-config
==> The configuration of the server my-host.marklogic.com. MarkLogic
Server responds with output similar to the following. (The security
certificate has been elided for brevity.) See the additional example
for the full join sequence.
HTTP/1.1 200 OK
Content-type: application/xml
Server: MarkLogic
Content-Length: 1487
Connection: Keep-Alive
Keep-Alive: timeout=5
<host xmlns="http://marklogic.com/manage">
<timestamp>2013-06-18T08:11:29.188561-07:00</timestamp>
<version>7.0</version>
<platform>linux</platform>
<edition>Essential Enterprise</edition>
<host-id>4808503609057420751</host-id>
<host-name>my-host.marklogic.com</host-name>
<bind-port>7999</bind-port>
<connect-port>7999</connect-port>
<foreign-bind-port>7998</foreign-bind-port>
<foreign-connect-port>7998</foreign-connect-port>
<ssl-certificate>...elided...</ssl-certificate>
</host>
|
Example:
Use in the following sequence to add a host to a cluster, assuming
clusterhost is a previously fully initialized bootstrap host for
the cluster and joining-host is the host to be initialized and added to
the cluster:
(1) Initialize the new host. For details, see POST /admin/v1/init.
Use GET /admin/v1/timestamp to verify a successful restart.
For details, see POST /admin/v1/init.
$ curl -X POST -d "" http://joining-host:8001/admin/v1/init
$ curl -X GET http://joining-host:8001/admin/v1/timestamp
(2) Retrieve the configuration of the joining host, to be used as the
value of the server-config param to POST /admin/v1/cluster-config.
$ curl -o joiner-config.xml -X GET -H "Accept: application/xml" \
http://joining-host:8001/admin/v1/server-config
==> The configuration for joining-host is saved to joiner-config.xml.
See the previous example for the output details.
(3) Send the joining host's URL encoded config info to the cluster host.
Receive the cluster configuration in return. For details, see
POST /admin/v1/cluster-config.
$ curl --anyauth --user user:password -X POST -d "group=Default" \
--data-urlencode "server-config@./joiner-config.xml" \
-H "Content-type: application/x-www-form-urlencoded" \
-o cluster-config.zip http://clusterhost:8001/admin/v1/cluster-config
==> The cluster configuration data is saved in cluster-config.zip.
(4) Send the cluster configuration ZIP file to the joining host to
complete the cluster join sequence. Bracket the POST with calls
to GET /admin/v1/timestamp to confirm a successful restart. For
details, see POST /admin/v1/cluster-config.
$ curl -X GET http://joining-host:8001/admin/v1/timestamp
$ curl -X POST -H "Content-type: application/zip" \
--data-binary @./cluster-config.zip \
http://joining-host:8001/admin/v1/cluster-config
$ curl --anyauth --user user:password -X GET \
http://joining-host:8001/admin/v1/timestamp
==> The joining host becomes a functional member of the cluster.
|
|
|
|
|
 |
Summary:
Verify that MarkLogic Server is up and accepting requests.
|
Response Headers:
Content-type:
The MIME type of the data in the response body. Always
text/plain.
|
|
Response:
If MarkLogic Server is available, this request returns response code
200 (OK) and the reponse body contains a plain text timestamp that can
be used with the timestamp returned by asynchronous admin
and manage requests to confirm that a restart ocurred
and has completed.
|
Usage Notes:
This request must be directed to the MarkLogic Server Admin Interface
on port 8001. For example:
http://localhost:8001/admin/v1/timestamp.
Management REST API that cause a restart usually return a reference
to this service in the response Location header and/or the data in
the response body. You can use this reference to test whether the
restart has successfully completed.
To test if MarkLogic Server is up and available on a given host, you
can use eiher the GET or HEAD methods of /admin/v1/timestamp. If
status code 200 (OK) is returned, MarkLogic Server is available.
To test for a restart, call GET /admin/v1/timestamp prior to the
operation that can cause a restart, then call it again afterwards,
and compare the two timestamps.
For details and a complete example, see
'Using the Timestamp Service to Verify a Restart' in the Scripting Administrative Tasks Guide.
|
Example:
curl --anyauth --user user:password -X GET -i \
http://localhost:8001/admin/v1/timestamp
==> MarkLogic Server responds with a timestamp and headers similar
to the following. The timestamp in the response body is the time
of the last restart.
HTTP/1.1 200 OK
Server: MarkLogic
Content-Type: text/plain; charset=UTF-8
Content-Length: 32
Connection: Keep-Alive
Keep-Alive: timeout=5
2013-05-15T10:34:38.932514-07:00
|
Example:
An operation causing a restart returns a response similar to the following.
Note the Location header and <uriref> to the timestamp service. Use it
to construct a GET or HEAD request to this service.
HTTP/1.1 202 Accepted
Content-type: application/xml
Location: /admin/v1/timestamp
Server: MarkLogic
Content-Length: 260
Connection: Keep-Alive
Keep-Alive: timeout=5
<restart xmlns="http://marklogic.com/manage">
<last-startup host-id="13544732455686476949">
2013-05-15T09:01:43.019261-07:00
</last-startup>
<link>
<kindref>timestamp</kindref>
<uriref>/admin/v1/timestamp</uriref>
</link>
<message>Check for new timestamp to verify host restart.</message>
</restart>
|
|
|
|
GET /manage/v2?view=query
|
|
 |
Summary:
This resource address returns the summary of all of the resources
in the local cluster, or resources in the local cluster that
match a query.
|
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.
|
name-match
:
Return only those resources that contain the specified string.
|
page-start
:
Return the resource results after the specified number of cluster resources.
|
page-length
:
Return the specified number of cluster resources in a result window.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK). The
response body contains the requested data.
|
Usage Notes:
Use page-start and page-length to fetch
resource information incrementally. These parameters refer to the
index and quantity of resources returned. For example, if there are
20 resources and you want to fetch data on the 6th through 10th ones,
set page-start=6&page-length=5.
The structure of the data
returned is as follows: A cluster-query element with the following element children:
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element children:
error-type
- The kind of error.
error-name
- The name of the error.
error-code
- The error identifier.
error-message
- The error text.
query-properties
- The properties of the query and its results.
This is a complex element with the following element children: query-criteria- The criteria that matches the resources.
This is a complex element with the following element children:
name-match
- A case-independent substring of the name
of the resources.
page-start- The offset to the first resource in the result page.
page-length- The number of resources in the result page.
result-count- The total number of results.
relations
- Relationships to resources.
This is a complex element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/query?name-match=myData&page-length=5
==> Returns information about the first 5 resources with a name
that include "myData".
|
|
|
|
GET /manage/v2?view=status
|
|
 |
Summary:
This resource address returns a status summary for the local cluster.
|
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.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK). The
response body contains the requested data.
|
Usage Notes:
The structure of the data
returned is as follows: A local-cluster-status element with the following element children:
id
-
A cluster ID.
name
-
A cluster name.
role
- The role (local or foreign ) of the cluster in the current environment.
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element children:
error-type
- The kind of error.
error-name
- The name of the error.
error-code
- The error identifier.
error-message
- The error text.
status-relations
This is a complex element with the following element children: hosts-status- Status of hosts for the cluster.
This is a complex element with the following element children:
uriref
- The path for a resource or list of resources.
typeref
- The type of a resource or list of resources.
hosts-status-summary
- Summary for the cluster hosts.
This is a complex element with the following element children:
total-hosts
- The total number of hosts.
load-properties
- The load properties of the cluster forests or hosts.
This is a complex element with the following element children:
total-load
- The sum of the processing load factors
in seconds per second.
load-detail
- The detailed load characteristics for the cluster forests or hosts.
This is a complex element with the following element children:
query-read-load
-
The moving average of the read load on the query, in seconds per second.
This is summed for all of the contributing threads.
journal-write-load
-
The moving average of the load for writing to the journal, in
seconds per second. This is summed for all of the threads
writing on the host.
save-write-load
-
The moving average of the load for writing to in-memory stands, in
seconds per second. This is summed for all of the threads
writing on the host.
merge-read-load
-
The moving average of the read load on the merge, in seconds per second.
This is summed for all of the contributing threads.
merge-write-load
-
The moving average of the load for writing for merges, in
seconds per second. This is summed for all of the threads
writing on the host.
backup-read-load
-
The moving average of the read load on the backup, in seconds per
second. This is summed for all of the contributing threads.
backup-write-load
-
The moving average of the load for writing for backups, in
seconds per second. This is summed for all of the threads
writing on the host.
restore-read-load
-
The moving average of the read load on the backup, in seconds per
second. This is summed for all of the contributing threads.
restore-write-load
-
The moving average of the load for writing for restores, in
seconds per second. This is summed for all of the threads
writing on the host.
large-read-load
-
The moving average of the read load on large documents, in seconds per
second.
large-write-load
-
The moving average of the load for writing for large documents, in
seconds per second.
external-binary-read-load
-
The moving average of the read load on external binary documents, in seconds per
second.
xdqp-client-receive-load
-
The moving average of the receive load for the xdqp client, in
seconds per second. This is summed for all of the contributing threads.
xdqp-client-send-load
-
The moving average of the send load for the xdqp client, in
seconds per second. This is summed for all of the contributing threads.
xdqp-server-receive-load
-
The moving average of the receive load for the xdqp server, in
seconds per second. This is summed for all of the contributing threads.
xdqp-server-send-load
-
The moving average of the send load for the xdqp server, in
seconds per second. This is summed for all of the contributing threads.
foreign-xdqp-client-receive-load
-
The moving average of the receive load for the xdqp client, in
seconds per second. This is summed for all of the contributing threads.
foreign-xdqp-client-send-load
-
The moving average of the send load for the xdqp client, in
seconds per second. This is summed for all of the contributing threads.
foreign-xdqp-server-receive-load
-
The moving average of the receive load for the xdqp server, in
seconds per second. This is summed for all of the contributing threads.
foreign-xdqp-server-send-load
-
The moving average of the send load for the xdqp server, in
seconds per second. This is summed for all of the contributing threads.
read-lock-wait-load
-
The read lock wait load, summed across all forests on the host.
read-lock-hold-load
-
The read lock hold load, summed across all forests on the host.
write-lock-wait-load
-
The write lock wait load, summed across all forests on the host.
write-lock-hold-load
-
The write lock hold load, summed across all forests on the host.
deadlock-wait-load
-
The deadlock wait load, summed across all forests on the host.
rate-properties
- The rate properties of the cluster forests or hosts.
This is a complex element with the following element children:
total-rate
- The sum of the processing rate factors
in seconds per second.
rate-detail
- The detailed rate characteristics for the cluster forests or hosts.
This is a complex element with the following element children:
memory-process-swap-rate
-
The swap rate for the MarkLogic process in pages/sec.
memory-system-pagein-rate
-
The page in rate for the system in pages/sec.
memory-system-pageout-rate
-
The page out rate for the system in pages/sec.
memory-system-swapin-rate
-
The swap in rate for the system in pages/sec.
memory-system-swapout-rate
-
The swap out rate for the system in pages/sec.
query-read-rate
-
The moving average of reading query data from disk, in megabytes
per second.
journal-write-rate
-
The moving average of writing data to the journal, in megabytes
per second.
save-write-rate
-
The moving average of writing data to in-memory stands, in megabytes
per second.
merge-read-rate
-
The moving average of reading merge data from disk, in megabytes
per second.
merge-write-rate
-
The moving average of writing data for merges, in megabytes
per second.
backup-read-rate
-
The moving average of reading backup data from disk, in megabytes
per second.
backup-write-rate
-
The moving average of writing data for backups, in megabytes
per second.
restore-read-rate
-
The moving average of reading restore data from disk, in megabytes
per second.
restore-write-rate
-
The moving average of writing data for restores, in megabytes
per second.
large-read-rate
-
The moving average of reading large documents from disk, in megabytes
per second.
large-write-rate
-
The moving average of writing data for large documents, in megabytes
per second.
external-binary-read-rate
-
The moving average of reading external binary documents from disk, in megabytes
per second.
xdqp-client-receive-rate
-
The moving average of receiving xdqp client messages, in megabytes
per second.
xdqp-client-send-rate
-
The moving average of sending xdqp client messages, in megabytes
per second.
xdqp-server-receive-rate
-
The moving average of receiving xdqp server messages, in megabytes
per second.
xdqp-server-send-rate
-
The moving average of sending xdqp server messages, in megabytes
per second.
foreign-xdqp-client-receive-rate
-
The moving average of receiving xdqp client messages, in megabytes
per second.
foreign-xdqp-client-send-rate
-
The moving average of sending xdqp client messages, in megabytes
per second.
foreign-xdqp-server-receive-rate
-
The moving average of receiving xdqp server messages, in megabytes
per second.
foreign-xdqp-server-send-rate
-
The moving average of sending xdqp server messages, in megabytes
per second.
read-lock-rate
-
The rate of taking read locks, summed across all forests on the host.
write-lock-rate
-
The rate of taking write locks, summed across all forests on the host.
deadlock-rate
-
The rate of taking write locks, summed across all forests on the host.
servers-status- Status of servers for the cluster.
This is a complex element with the following element children:
uriref
- The path for a resource or list of resources.
typeref
- The type of a resource or list of resources.
servers-status-summary
- Summary for the cluster servers.
This is a complex element with the following element 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 the cluster.
forests-status- Status of forests for the cluster.
This is a complex element with the following element children:
uriref
- The path for a resource or list of resources.
typeref
- The type of a resource or list of resources.
forests-status-summary
- Summary for the cluster forests.
This is a complex element with the following element children:
total-forests
- The total number of forests.
state-not-open
- The number of forests that aren't open.
max-stands-per-forest
- The maximum number of stands for a forest.
merge-count
- The maximum number of forests that are merging.
backup-count
- The maximum number of forests that are backing up.
restore-count
- The maximum number of forests that are restoring.
min-capacity
- The least capacity for a forest as a percentage.
cache-properties
- The cache properties for the forests.
This is a complex element with the following element children:
list-cache-hit-rate
-
The average number of hits on the list cache.
list-cache-miss-rate
-
The average number of misses on the list cache.
triple-cache-hit-rate
-
The average number of hits on the list cache.
triple-cache-miss-rate
-
The average number of misses on the list cache.
triple-value-cache-hit-rate
-
The average number of hits on the list cache.
triple-value-cache-miss-rate
-
The average number of misses on the list cache.
compressed-tree-cache-hit-rate
-
The average number of hits on the compressed cache.
compressed-tree-cache-miss-rate
-
The average number of misses on the compressed cache.
list-cache-ratio
triple-cache-ratio
triple-value-cache-ratio
compressed-tree-cache-ratio
large-binary-cache-hit-rate
-
The average number of hits on the large binary cache.
large-binary-cache-miss-rate
-
The average number of misses on the large binary cache.
requests-status- Status of requests for the cluster.
This is a complex element with the following element children:
uriref
- The path for a resource or list of resources.
typeref
- The type of a resource or list of resources.
requests-status-summary
- Summary for the cluster requests.
This is a complex element with the following element 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.
transactions-status- Status of transactions for the cluster.
This is a complex element with the following element children:
uriref
- The path for a resource or list of resources.
typeref
- The type of a resource or list of resources.
transactions-status-summary
- Summary for the cluster transactions.
This is a complex element with the following element 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-transactions
- The total number
of open transactions.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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?view=status
(: Returns a status summary information for the local cluster. :)
|
|
|
|
|
 |
Summary:
This resource address returns summary information for the local cluster.
|
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 schema,
status, metrics, query, 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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
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:
A local-cluster-default element with the following element children:
id
-
A cluster ID.
name
-
A cluster name.
role
- The role (local or foreign ) of the cluster in the current environment.
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/
(: Returns summary information for the cluster. :)
|
|
|
|
|
 |
Summary:
This resource address returns a list of all of the clusters coupled to the
local cluster.
|
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 schema,
metrics, or default.
|
cluster-role
:
A view of the local cluster or foreign clusters. Can be either
all, local, or foreign.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
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. For details on the metrics view, see
GET /manage/v2/clusters?view=metrics.
A cluster-default-list element with the following element children:
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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-items
- Items of this resource type.
This is a complex element with the following element children: list-count- The number of items of this resource type.
list-item- An item of this resource type.
This is a complex element with the following element children:
uriref
- The path for 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.
item-summary
This is a complex element with the following element children:
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/clusters
(: Returns a list of foreign clusters coupled to this cluster. :)
|
|
|
|
GET /manage/v2/clusters?view=metrics
|
|
 |
Summary:
Retrieve historical monitoring data for the clusters coupled to the
local cluster.
|
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.
|
cluster-role
:
A view of the local cluster or foreign clusters. Can be either
all, local, or foreign.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK). The
response body contains the requested data.
|
Example:
http://localhost:8002/manage/v2/clusters?view=metrics
(: Returns historical monitoring data about clusters coupled to this cluster. :)
|
|
|
|
GET /manage/v2/clusters/{id|name}
|
|
 |
Summary:
This resource address returns summary information for the specified
foreign cluster.
|
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 schema,
status, query, metrics 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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK). The
response body contains the requested data.
|
Usage Notes:
You can address the local cluster at /manage/v2, without specifying
the full /manage/v2/clusters/{id|name}.
The structure of the data in the response for the default view
is as follows:
A local-cluster-default element with the following element children:
id
-
A cluster ID.
name
-
A cluster name.
role
- The role (local or foreign ) of the cluster in the current environment.
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/clusters/Replica
(: Returns summary informaton for the foreign cluster named Replica. :)
|
|
|
|
POST /manage/v2/clusters/{id|name}
|
|
 |
Summary:
Initiate a state change on the named cluster, such as a shutdown or restart.
|
Parameters:
state
:
The type of state change to initiate. Allowed values:
shutdown, restart. Specify this parameter
as form data in the POST body.
|
format
:
The format of the returned data. Can be either json,
or xml (default). This value overrides the Accept header
if both are present.
|
|
Request Headers:
Accept*:
The expected MIME type of the response. If the format
parameter is present, it takes precedence over the Accept header.
Supported values: application/xml,
application/json.
|
Content-type:
The MIME type of the data in the request body. The only supported
value is application/x-www-form-urlencoded.
|
|
Response Headers:
Content-type:
The MIME type of the data in the response body. Use the Accept header
or format request parameter to specify a preferred format.
The format parameter takes precedence over the Accept
header if both are present.
|
|
Required Privilege:
This operation requires the manage-admin role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage-admin
|
Response:
MarkLogic Server returns status code 202 (Accepted). The response
body includes a list of restarted hosts and their last start times.
|
Usage Notes:
The POST body must contain the state parameter, as
HTML form data. For example: state=restart.
You cannot initiate a state change on a foreign cluster.
You can address the local cluster at /manage/v2, without specifying
the full /manage/v2/clusters/{id|name}.
|
Example:
$ curl --anyauth --user user:password -X POST --data "state=shutdown" \
http://localhost:8002/manage/v2/clusters/123409234245
==> Initiate a shutdown of the local cluster using the cluster id.
MarkLogic responds with output similar to the following. This output
represents a 2-host cluster.
Content-type: application/xml
Server: MarkLogic
Content-Length: 160
Connection: Keep-Alive
Keep-Alive: timeout=5
HTTP/1.1 202 Accepted
Content-type: application/xml
Cache-Control: no-cache
Expires: -1
Server: MarkLogic
Content-Length: 313
Connection: Keep-Alive
Keep-Alive: timeout=5
<shutdown xmlns="http://marklogic.com/manage">
<last-startup host-id="13544732455686476949">
2013-09-21T09:45:07.936648-07:00</last-startup>
<last-startup host-id="11346873982344721834">
2013-09-21T09:45:07.57723-07:00
</last-startup>
<message>Shutdown of cluster (17224434944267874968) initiated.</message>
</shutdown>
The following is the equivalent JSON output:
{ "shutdown": {
"last-startup": [
{
"host-id": "13544732455686476949",
"value": "2013-09-21T09:55:40.567285-07:00"
},
{
"host-id": "11346873982344721834",
"value": "2013-09-21T09:55:40.567285-07:00"
}
],
"link": {
"kindref": "timestamp",
"uriref": "/admin/v1/timestamp"
},
"message": "Check for new timestamp to verify host restart."
} }
|
Example:
$ curl --anyauth --user user:password -i -X POST --data "state=restart" \
http://localhost:8002/manage/v2
==> Initiate a restart of the local cluster, using the /manage/v2 shorthand.
Use the returned restart information and the timestamp service to
determine when the restart is complete. The output below represents a
2-host cluster.
Content-type: application/xml
Server: MarkLogic
Content-Length: 160
Connection: Keep-Alive
Keep-Alive: timeout=5
HTTP/1.1 202 Accepted
Content-type: application/xml
Cache-Control: no-cache
Expires: -1
Location: /admin/v1/timestamp
Server: MarkLogic
Content-Length: 383
Connection: Keep-Alive
Keep-Alive: timeout=5
<restart xmlns="http://marklogic.com/manage">
<last-startup host-id="13544732455686476949">
2013-09-21T09:44:49.498658-07:00
</last-startup>
<last-startup host-id="11346873982344721834">
2013-09-21T09:44:49.434052-07:00
</last-startup>
<link>
<kindref>timestamp</kindref>
<uriref>/admin/v1/timestamp</uriref>
</link>
<message>Check for new timestamp to verify host restart.</message>
</restart>
The following is the equivalent JSON output:
{ "restart": {
"last-startup": [
{
"host-id": "13544732455686476949",
"value": "2013-09-21T09:55:40.567285-07:00"
},
{
"host-id": "11346873982344721834",
"value": "2013-09-21T09:55:40.567285-07:00"
}
],
"link": {
"kindref": "timestamp",
"uriref": "/admin/v1/timestamp"
},
"message": "Check for new timestamp to verify host restart."
} }
|
Example:
$ curl --anyauth --user user:password -X POST -i --data "state=restart" \
-H "Accept: application/json" http://localhost:8002/manage/v2
==> Initiate a restart of the local cluster, using the /manage/v2 shorthand.
Output is returned as JSON, due to the Accept header. The output below
represents a 2-host cluster.
Content-type: application/json
Server: MarkLogic
Content-Length: 104
Connection: Keep-Alive
Keep-Alive: timeout=5
HTTP/1.1 202 Accepted
Content-type: application/json
Cache-Control: no-cache
Expires: -1
Location: /admin/v1/timestamp
Server: MarkLogic
Content-Length: 235
Connection: Keep-Alive
Keep-Alive: timeout=5
{ "restart": {
"last-startup": {
"host-id": "11346873982344721834",
"value": "2013-09-21T09:55:02.216597-07:00"
},
"link": {
"kindref": "timestamp",
"uriref": "/admin/v1/timestamp"
},
"message": "Check for new timestamp to verify host restart."
} }
|
|
|
|
GET /manage/v2/clusters/{id|name}?view=config
|
|
 |
Summary:
Retrieve configuration information for the named foreign cluster.
|
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.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK). The
response body contains the requested data.
|
Usage Notes:
The structure of the data
returned is as follows: A foreign-cluster-config element with the following element children:
id
-
A cluster ID.
name
-
A cluster name.
role
- The role (local or foreign ) of the cluster in the current environment.
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element children:
error-type
- The kind of error.
error-name
- The name of the error.
error-code
- The error identifier.
error-message
- The error text.
foreign-config-properties
- The configuration properties of a foreign cluster.
This is a complex element with the following element children: foreign-cluster-id- The foreign cluster ID.
foreign-cluster-name- The foreign cluster name.
xdqp-timeout-
The XDQP protocol timeout, in seconds.
host-timeout-
The host response timeout, in seconds.
xdqp-ssl-enabled-
Whether or not SSL is enabled for XDQP.
xdqp-ssl-allow-sslv3-
Whether or not SSLv3 is allowed for XDQP.
xdqp-ssl-allow-tls-
Whether or not TLS is allowed for XDQP.
xdqp-ssl-ciphers-
A colon separated list of ciphers (e.g. ALL:!LOW:@STRENGTH)
foreign-hosts-
Information about foreign hosts.
This is a complex element with the following element children:
foreign-host
This is a complex element with the following element children:
foreign-host-id
-
The ID of the foreign host.
foreign-host-name
-
The name of the foreign host.
foreign-connect-port
-
The connect port for the foreign host.
online
-
Is this online.
secure
-
Is SSL enabled.
last-online
-
The time it was last online.
last-offline
-
The time it was last offline.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/clusters/Replica?view=config
(: Returns configuration informaton for the foreign cluster named Replica. :)
|
|
|
|
GET /manage/v2/clusters/{id|name}?view=status
|
|
 |
Summary:
This resource address returns a status summary for the specified
foreign cluster.
|
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.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK). The
response body contains the requested data.
|
Usage Notes:
Address the local cluster at /manage/v2, without specifying
the full /manage/v2/clusters/{id|name}.
The structure of the data
returned is as follows: A foreign-cluster-status element with the following element children:
id
-
A cluster ID.
name
-
A cluster name.
role
- The role (local or foreign ) of the cluster in the current environment.
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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.
foreign-status-properties
- The operating characteristics of the foreign cluster.
This is a complex element with the following element children: is-bootstrapped- A flag indicating whether all boostrap hosts are bootstrapped to the foreign cluster.
bootstrap-host-detail- A foreign cluster status
This is a complex element with the following element children:
host-id
- The unique key of the host
interesting
-
Is this interesting.
bootstrapped
-
Is this bootstrapped.
last-successful-bootstrap
-
The time of the last bootstrap.
foreign-hosts
-
Information about foreign hosts.
This is a complex element with the following element children:
foreign-host
This is a complex element with the following element children:
foreign-host-id
-
The ID of the foreign host.
foreign-host-name
-
The name of the foreign host.
foreign-connect-port
-
The connect port for the foreign host.
online
-
Is this online.
secure
-
Is SSL enabled.
last-online
-
The time it was last online.
last-offline
-
The time it was last offline.
foreign-databases
-
Information about foreign databases.
This is a complex element with the following element children:
foreign-database
-
Information about a particular foreign database.
This is a complex element with the following element children:
foreign-database-id
-
The ID of the foreign database.
foreign-database-name
-
The name of the foreign database.
enabled
-
Is this enabled.
foreign-forest-ids
This is a complex element with the following element children:
foreign-forest-id
-
The ID of the foreign forest.
foreign-forests
-
Information about foreign forests.
This is a complex element with the following element children:
foreign-forest
-
Information about a particular foreign forest.
This is a complex element with the following element children:
foreign-forest-id
-
The ID of the foreign forest.
foreign-forest-name
-
The name of the foreign forest.
foreign-host-id
-
The ID of the foreign host.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/clusters/Replica?view=status
(: Returns status informaton for the foreign cluster named Replica. :)
|
|
|
|
|
 |
Summary:
This resource address returns a summary of the databases in the cluster.
|
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:
A database-default-list element with the following element children:
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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-items
- Items of this resource type.
This is a complex element with the following element children: list-count- The number of items of this resource type.
list-item- An item of this resource type.
This is a complex element with the following element children:
uriref
- The path for 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.
item-summary
This is a complex element with the following element children:
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/databases
(: Returns a list of the databases in the cluster. :)
|
|
|
|
GET /manage/v2/databases/{id|name}
|
|
 |
Summary:
This resource address returns information on the specified database.
The database can be identified either by id or name.
|
Parameters:
format?
:
The format of the returned data. Can be either html,
json, or xml (default). This parameter is
not meaningful with view=edit. This value overrides the
Accept header if both are present.
|
view?
:
A specific view of the returned data. Can be either config,
counts, edit, status,
package, or default
(the default view).
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
For all views except edit, upon success, MarkLogic
Server returns status code 200 (OK), and the response body contains
the requested data. If view=edit, MarkLogic Server
responds with status code 302 (Found) and the Location header contains
a redirect to the appropriate page in the Admin Interface.
|
Usage Notes:
The counts returns count information for the forests attached
to the specified database. The count information includes the document
count, directory count, active fragment count, deleted fragment count, and
nascent fragment count.
The structure of the data in the response for the default view
is as follows:
A database-default element with the following element children:
id
-
The database id.
name
-
The database name.
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/databases/Documents
==> Returns information on the Documents database.
|
Example:
http://localhost:8002/manage/v2/databases/Documents?view=status
==> Returns status information on the Documents database.
|
|
|
|
GET /manage/v2/databases/{id|name}?view=config
|
|
 |
Summary:
This resource address returns configuration information for the named
database. The database can be identified either by id or name.
|
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.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK), and the
response body contains the requested data.
|
Usage Notes:
The structure of the data
returned is as follows: A database-config element with the following element children:
id
-
The database id.
name
-
The database name.
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element children:
error-type
- The kind of error.
error-name
- The name of the error.
error-code
- The error identifier.
error-message
- The error text.
config-properties
- The configuration properties of a database.
This is a complex element with the following element children: enabled-
Is the forest enabled or not.
retired-forest-count-
The number of retired forests in a database.
language-
The default language assumed for content (if xml:lang encoding is absent)
stemmed-searches-
Enable stemmed word searches
(slower document loads and larger database files).
word-searches-
Enable unstemmed word searches
(slower document loads and larger database files).
word-positions-
Index word positions
for faster phrase and near searches
(slower document loads and larger database files).
fast-phrase-searches-
Enable faster phrase searches
(slower document loads and larger database files).
fast-reverse-searches-
Enable faster reverse searches
(slower document loads and larger database files).
triple-index-
Enable the RDF triple index
(slower document loads and larger database files).
triple-positions-
Index triple positions
for faster near searches involving cts:triple-range-query
(slower document loads and larger database files).
fast-case-sensitive-searches-
Enable faster case sensitive searches
(slower document loads and larger database files).
fast-diacritic-sensitive-searches-
Enable faster diacritic sensitive searches
(slower document loads and larger database files).
fast-element-word-searches-
Enable faster element-word searches
(slower document loads and larger database files).
element-word-positions-
Index element word positions
for faster element-based phrase and near searches
(slower document loads and larger database files).
fast-element-phrase-searches-
Enable faster element phrase searches
(slower document loads and larger database files).
element-value-positions-
Index element value positions
for faster near searches involving element-value-query
(slower document loads and larger database files).
attribute-value-positions-
Index attribute value positions
for faster near searches involving element-attribute-value-query
(slower document loads and larger database files).
field-value-searches-
Index field values
for faster searches involving field-value-query
(slower document loads and larger database files).
field-value-positions-
Index field value positions
for faster near searches involving field-value-query
(slower document loads and larger database files).
three-character-searches-
Enable wildcard searches
and faster character-based XQuery predicates
using three or more characters
(slower document loads and larger database files).
three-character-word-positions-
Index word positions
for three-character searches
only when three-character-searches are enabled
(slower document loads and larger database files).
fast-element-character-searches-
Enable element wildcard searches
and element-character-based XQuery predicates
(slower document loads and larger database files).
trailing-wildcard-searches-
Enable trailing wildcard searches
(slower document loads and larger database files).
trailing-wildcard-word-positions-
Index word positions
for trailing-wildcard searches
only when trailing-wildcard-searches are enabled
(slower document loads and larger database files).
fast-element-trailing-wildcard-searches-
Enable element trailing wildcard searches
(slower document loads and larger database files).
word-lexicons-
A list of word lexicons. Each lexicon is defined by its collation uri.
This is a complex element with the following element children:
word-lexicon
-
Maintain a lexicon of words (slower document loads and larger
database files).
two-character-searches-
Enable wildcard searches
and faster character-based XQuery predicates
using two character
(slower document loads and larger database files).
one-character-searches-
Enable wildcard searches
and faster character-based XQuery predicates
using one character
(slower document loads and larger database files).
uri-lexicon-
Maintain a lexicon of document URIs
(slower document loads and larger database files).
collection-lexicon-
Maintain a lexicon of collection URIs
(slower document loads and larger database files).
reindexer-enable-
Enable automatic reindexing after configuration changes.
reindexer-throttle-
Larger numbers mean work harder at reindexing.
reindexer-timestamp-
Reindex/refragment all fragments with timestamps less than or equal to
the timestamp specified. 0 means no forced reindexing.
directory-creation-
Automatically (for WebDAV) or manually manage directories
maintain-last-modified-
Maintain last-modified properties of documents.
maintain-directory-last-modified-
Maintain last-modified properties of directories.
inherit-permissions-
New document default permissions include parent directory permissions.
inherit-collections-
New document default collections include parent directory collections.
inherit-quality-
New document default quality is inherited parent directory quality.
in-memory-limit-
The maximum number of fragments in an in-memory stand.
in-memory-list-size-
Size of the in-memory list storage, in megabytes.
in-memory-tree-size-
Size of the in-memory tree storage, in megabytes.
in-memory-range-index-size-
Size of the in-memory range index storage, in megabytes.
in-memory-reverse-index-size-
Size of the in-memory reverse index storage, in megabytes.
in-memory-triple-index-size-
Size of the in-memory triple index storage, in megabytes.
large-size-threshold-
Size threshold for large objects, in kilobytes.
locking-
Specifies how robust transaction locking should be.
journaling-
Specifies how robust transaction journaling should be.
journal-size-
Size of each journal file, in megabytes.
journal-count-
The number of journal files.
preallocate-journals-
Allocate journal files before executing transactions.
preload-mapped-data-
Preload memory mapped forest information while mounting forest.
preload-replica-mapped-data-
Preload memory mapped forest information while mounting replica forest.
range-index-optimize-
Specifies how to optimize range indexes.
positions-list-max-size-
Maximum size of a positions-containing list, in megabytes.
Lists longer than this have positions discarded.
format-compatibility-
Version of on-disk forest format.
index-detection-
Handling of differences between the current configuration of
database indexes and on-disk settings.
expunge-locks-
Garbage collection of timed locks that have expired.
tf-normalization-
What kind of TF normalization to apply.
merge-priority-
The CPU scheduler priority for merges.
merge-max-size-
Maximum allowable size (in megabytes) for merges,
or 0 for no limit.
merge-min-size-
Stands with fewer than this number of fragments are merged together.
merge-min-ratio-
Larger ratios trigger more merges.
merge-timestamp-
The earliest system timestamp allowed for requests, or 0 to
indicate the timestamp corresponding to the time of latest merge.
Merges discard information about earlier timestamps.
Entering a value of type xs:dateTime will have it automatically
converted to its corresponding timestamp.
A negative value indicates a timestamp relative to
the time of the latest merge, at ten million ticks per second.
For example, -6000000000 means ten minutes before the latest merge.
A value in red indicates that you have filled in the text
field with the current timestamp, but have not clicked ok to save the
value to your config file.
merge-blackouts-
Periods during which merges will not occur.
This is a complex element with the following element children:
merge-blackout
-
A merge blackout specification.
This is a complex element with the following element children:
blackout-type
-
What type of blackout is this.
limit
-
Maximum allowable size (in megabytes) for merges
that occur during a blackout period, or 0 to disable
merges completely.
merge-priority
-
The CPU scheduler priority for merges.
days
-
The days that this blackout is active.
This is a complex element with the following element children:
day
-
A day that this blackout is active.
period
-
A period, which is all day, a start time and a duration, or a
start and end time.
This is a complex element with the following element children:
start-date
-
The starting date (in MM/DD/YYYY notation)
start-time
-
The time a merge started.
end-date
-
The ending date (in MM/DD/YYYY notation)
end-time
-
The ending time (in 24:00 notation).
duration
-
The duration, specifed as hours:minutes (i.e. 2 hours 5 minutes is 2:05)
database-backups-
Backups scheduled for this database.
This is a complex element with the following element children:
database-backup
-
A scheduled database backup.
This is a complex element with the following element children:
backup-directory
-
The backup directory pathname.
backup-type
-
What type of backup is this.
backup-period
-
How often this backup should run (every n months, weeks, days, hours or minutes).
backup-month-day
-
The day of the month that this backup happens.
backup-days
-
The days that this backup happens.
This is a complex element with the following element children:
backup-day
-
A day that this backup occurs.
backup-start-date
-
The starting date (in MM/DD/YYYY notation) for this backup.
backup-start-time
-
The starting time (in 24:00 notation) for this backup.
backup-timestamp
-
The date and time this backup was created.
max-backups
-
The maximum number of backups to keep for this scheduled backup.
backup-schemas-database
-
Backup the schemas database for this database.
backup-security-database
-
Backup the security database for this database.
backup-triggers-database
-
Backup the triggers database for this database.
include-replicas
-
Backup the replica forests as well as the master forests.
journal-archiving
-
Is journal archiving enabled for the backup?
journal-archive-path
-
Path to the associated journal archive location.
journal-archive-lag-limit
-
Number of seconds the archived journal can lag the active journal.
fragment-roots-
The fragment root specifications.
This is a complex element with the following element children:
fragment-root
-
A fragment root specification.
This is a complex element with the following element children:
namespace-uri
-
A namespace URI.
localname
-
One or more localnames.
fragment-parents-
The fragment parent specifications.
This is a complex element with the following element children:
fragment-parent
-
A fragment parent specification.
This is a complex element with the following element children:
namespace-uri
-
A namespace URI.
localname
-
One or more localnames.
element-word-query-throughs-
The element-word-query-through specifications.
This is a complex element with the following element children:
element-word-query-through
-
Element-word-query matches may cross these markup boundaries.
This is a complex element with the following element children:
namespace-uri
-
A namespace URI.
localname
-
One or more localnames.
phrase-throughs-
The phrase-through specifications.
This is a complex element with the following element children:
phrase-through
-
Phrases may cross these markup boundaries.
This is a complex element with the following element children:
namespace-uri
-
A namespace URI.
localname
-
One or more localnames.
phrase-arounds-
The phrase-around specifications.
This is a complex element with the following element children:
phrase-around
-
Phrases may jump around these elements.
This is a complex element with the following element children:
namespace-uri
-
A namespace URI.
localname
-
One or more localnames.
range-element-indexes-
Indexes for fast inequality comparisons.
This is a complex element with the following element children:
range-element-index
-
An index for fast element inequality comparisons.
This is a complex element with the following element children:
scalar-type
-
The scalar type of a range index.
namespace-uri
-
A namespace URI.
localname
-
One or more localnames.
collation
-
A collation URI for string comparisons.
range-value-positions
-
Index range value positions
for faster near searches involving range queries
(slower document loads and larger database files).
invalid-values
-
Allow ingestion of documents that do not have matching type of data.
range-element-attribute-indexes-
Indexes for fast element-attribute inequality comparisons.
This is a complex element with the following element children:
range-element-attribute-index
-
An index for fast element-attribute inequality comparisons.
This is a complex element with the following element children:
scalar-type
-
The scalar type of a range index.
parent-namespace-uri
-
A namespace URI.
parent-localname
-
One or more localnames.
namespace-uri
-
A namespace URI.
localname
-
One or more localnames.
collation
-
A collation URI for string comparisons.
range-value-positions
-
Index range value positions
for faster near searches involving range queries
(slower document loads and larger database files).
invalid-values
-
Allow ingestion of documents that do not have matching type of data.
element-word-lexicons-
Maintain lexicons of words in elements.
This is a complex element with the following element children:
element-word-lexicon
-
Maintain a lexicon of words in an element.
This is a complex element with the following element children:
namespace-uri
-
A namespace URI.
localname
-
One or more localnames.
collation
-
A collation URI for string comparisons.
element-attribute-word-lexicons-
Maintain lexicons of words in elements.
This is a complex element with the following element children:
element-attribute-word-lexicon
-
Maintain a lexicon of words in an element attribute.
This is a complex element with the following element children:
parent-namespace-uri
-
A namespace URI.
parent-localname
-
One or more localnames.
namespace-uri
-
A namespace URI.
localname
-
One or more localnames.
collation
-
A collation URI for string comparisons.
path-namespaces-
The namespace binding specifications for Path indexes.
This is a complex element with the following element children:
path-namespace
-
A namespace binding specification.
This is a complex element with the following element children:
prefix
-
A QName prefix.
namespace-uri
-
A namespace URI.
range-path-indexes-
Indexes for fast inequality comparisons.
This is a complex element with the following element children:
range-path-index
-
An index for fast path inequality comparisons.
This is a complex element with the following element children:
scalar-type
-
The scalar type of a range index.
path-expression
-
The path expression.
collation
-
A collation URI for string comparisons.
range-value-positions
-
Index range value positions
for faster near searches involving range queries
(slower document loads and larger database files).
invalid-values
-
Allow ingestion of documents that do not have matching type of data.
fields-
The fields specifications.
This is a complex element with the following element children:
field
-
The field specifications.
This is a complex element with the following element children:
field-name
-
The field name.
include-root
-
Includes elements starting at the document root.
field-path
-
The path in the field.
This is a complex element with the following element children:
path
-
The path of the stand.
weight
-
The weight, used to boost or lower relevance scores.
stemmed-searches
-
Enable stemmed word searches
(slower document loads and larger database files).
word-searches
-
Enable unstemmed word searches
(slower document loads and larger database files).
field-value-searches
-
Index field values
for faster searches involving field-value-query
(slower document loads and larger database files).
field-value-positions
-
Index field value positions
for faster near searches involving field-value-query
(slower document loads and larger database files).
fast-phrase-searches
-
Enable faster phrase searches
(slower document loads and larger database files).
fast-case-sensitive-searches
-
Enable faster case sensitive searches
(slower document loads and larger database files).
fast-diacritic-sensitive-searches
-
Enable faster diacritic sensitive searches
(slower document loads and larger database files).
trailing-wildcard-searches
-
Enable trailing wildcard searches
(slower document loads and larger database files).
trailing-wildcard-word-positions
-
Index word positions
for trailing-wildcard searches
only when trailing-wildcard-searches are enabled
(slower document loads and larger database files).
three-character-searches
-
Enable wildcard searches
and faster character-based XQuery predicates
using three or more characters
(slower document loads and larger database files).
three-character-word-positions
-
Index word positions
for three-character searches
only when three-character-searches are enabled
(slower document loads and larger database files).
two-character-searches
-
Enable wildcard searches
and faster character-based XQuery predicates
using two character
(slower document loads and larger database files).
one-character-searches
-
Enable wildcard searches
and faster character-based XQuery predicates
using one character
(slower document loads and larger database files).
word-lexicons
-
A list of word lexicons. Each lexicon is defined by its collation uri.
This is a complex element with the following element children:
word-lexicon
-
Maintain a lexicon of words (slower document loads and larger
database files).
included-elements
-
The elements included in the field.
This is a complex element with the following element children:
included-element
-
The element included in the field.
This is a complex element with the following element children:
namespace-uri
-
A namespace URI.
localname
-
One or more localnames.
weight
-
The weight, used to boost or lower relevance scores.
attribute-namespace-uri
-
Namespace of the child attribute.
attribute-localname
-
Localname of the child attribute.
attribute-value
-
Include or Exclude only elements with the specified attribute having this value.
excluded-elements
-
The elements excluded from the field.
This is a complex element with the following element children:
excluded-element
-
The element excluded from the field.
This is a complex element with the following element children:
namespace-uri
-
A namespace URI.
localname
-
One or more localnames.
attribute-namespace-uri
-
Namespace of the child attribute.
attribute-localname
-
Localname of the child attribute.
attribute-value
-
Include or Exclude only elements with the specified attribute having this value.
tokenizer-overrides
This is a complex element with the following element children:
tokenizer-override
This is a complex element with the following element children:
character
-
The character to override.
tokenizer-class
range-field-indexes-
Indexes for fast inequality comparisons.
This is a complex element with the following element children:
range-field-index
-
An index for fast field inequality comparisons.
This is a complex element with the following element children:
scalar-type
-
The scalar type of a range index.
field-name
-
The field name.
collation
-
A collation URI for string comparisons.
range-value-positions
-
Index range value positions
for faster near searches involving range queries
(slower document loads and larger database files).
invalid-values
-
Allow ingestion of documents that do not have matching type of data.
geospatial-element-indexes-
Indexes for fast geospatial element comparisons.
This is a complex element with the following element children:
geospatial-element-index
-
Element value geospatial index. Element content has point value.
This is a complex element with the following element children:
namespace-uri
-
A namespace URI.
localname
-
One or more localnames.
coordinate-system
-
A coordinate system name.
point-format
-
The general format of the point.
range-value-positions
-
Index range value positions
for faster near searches involving range queries
(slower document loads and larger database files).
invalid-values
-
Allow ingestion of documents that do not have matching type of data.
geospatial-element-child-indexes-
Indexes for fast geospatial element comparisons.
This is a complex element with the following element children:
geospatial-element-child-index
-
Element child value geospatial index.
Child element content has point value.
This is a complex element with the following element children:
parent-namespace-uri
-
A namespace URI.
parent-localname
-
One or more localnames.
namespace-uri
-
A namespace URI.
localname
-
One or more localnames.
coordinate-system
-
A coordinate system name.
point-format
-
The general format of the point.
range-value-positions
-
Index range value positions
for faster near searches involving range queries
(slower document loads and larger database files).
invalid-values
-
Allow ingestion of documents that do not have matching type of data.
geospatial-element-pair-indexes-
Indexes for fast geospatial element comparisons.
This is a complex element with the following element children:
geospatial-element-pair-index
- Element pair geospatial index.
Point value is divided into latitude and longitude
in child element content.
This is a complex element with the following element children:
parent-namespace-uri
-
A namespace URI.
parent-localname
-
One or more localnames.
latitude-namespace-uri
-
A namespace URI.
latitude-localname
-
One or more localnames.
longitude-namespace-uri
-
A namespace URI.
longitude-localname
-
One or more localnames.
coordinate-system
-
A coordinate system name.
range-value-positions
-
Index range value positions
for faster near searches involving range queries
(slower document loads and larger database files).
invalid-values
-
Allow ingestion of documents that do not have matching type of data.
geospatial-element-attribute-pair-indexes-
Indexes for fast geospatial element comparisons.
This is a complex element with the following element children:
geospatial-element-attribute-pair-index
- Attribute pair geospatial index.
Point value is divided into latitude and longitudes in
attribute content.
This is a complex element with the following element children:
parent-namespace-uri
-
A namespace URI.
parent-localname
-
One or more localnames.
latitude-namespace-uri
-
A namespace URI.
latitude-localname
-
One or more localnames.
longitude-namespace-uri
-
A namespace URI.
longitude-localname
-
One or more localnames.
coordinate-system
-
A coordinate system name.
range-value-positions
-
Index range value positions
for faster near searches involving range queries
(slower document loads and larger database files).
invalid-values
-
Allow ingestion of documents that do not have matching type of data.
geospatial-path-indexes-
Indexes for fast geospatial path-based comparisons.
This is a complex element with the following element children:
geospatial-path-index
-
Path value geospatial index. Path leaf content has point value.
This is a complex element with the following element children:
path-expression
-
The path expression.
coordinate-system
-
A coordinate system name.
point-format
-
The general format of the point.
range-value-positions
-
Index range value positions
for faster near searches involving range queries
(slower document loads and larger database files).
invalid-values
-
Allow ingestion of documents that do not have matching type of data.
database-replication-
Database replication configuration.
This is a complex element with the following element children:
foreign-replicas
-
Information about foreign replicas.
This is a complex element with the following element children:
foreign-replica
-
Foreign replica of this database.
This is a complex element with the following element children:
relation
- A specific related resource.
This is a complex element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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 foreign cluster related to the database.
foreign-database-id
-
The ID of the foreign database.
connect-forests-by-name
-
Automatically connect local forests with foreign forests of the same name.
lag-limit
-
The lag limit.
replication-enabled
-
Whether replication is enabled for this replica.
foreign-master
-
Foreign master for this database.
This is a complex element with the following element children:
relation
- A specific related resource.
This is a complex element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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 foreign cluster related to the database.
foreign-database-id
-
The ID of the foreign database.
connect-forests-by-name
-
Automatically connect local forests with foreign forests of the same name.
database-references-
Cluster of clusters configuration.
This is a complex element with the following element children:
database-reference
-
Foreign database.
This is a complex element with the following element children:
reference-cluster-id
-
A foreign cluster id.
reference-database-id
-
A foreign database id.
rebalancer-enable-
Is the rebalancer on this forest enabled or not.
rebalancer-throttle-
Larger numbers mean work harder at rebalancing.
assignment-policy-
The policy to use for assignment and rebalancing.
This is a complex element with the following element children:
assignment-policy-name
-
What policy to use for assignment and rebalancing.
partition-key
-
The partition key of the range assignment policy.
This is a complex element with the following element children:
cts:base-reference
lower-bound-included
-
If this is true, ranges on all forests in this database include the
lower bound but not the upper bound (i.e., [lower-bound, upper-bound));
if this is false, ranges on all forests include the upper bound
but not the lower bound (i.e., (lower-bound, upper-bound]).
word-query- The configuration properties for word query.
This is a complex element with the following element children:
include-root
-
Includes elements starting at the document root.
field-path
-
The path in the field.
This is a complex element with the following element children:
path
-
The path of the stand.
weight
-
The weight, used to boost or lower relevance scores.
stemmed-searches
-
Enable stemmed word searches
(slower document loads and larger database files).
word-searches
-
Enable unstemmed word searches
(slower document loads and larger database files).
field-value-searches
-
Index field values
for faster searches involving field-value-query
(slower document loads and larger database files).
field-value-positions
-
Index field value positions
for faster near searches involving field-value-query
(slower document loads and larger database files).
fast-phrase-searches
-
Enable faster phrase searches
(slower document loads and larger database files).
fast-case-sensitive-searches
-
Enable faster case sensitive searches
(slower document loads and larger database files).
fast-diacritic-sensitive-searches
-
Enable faster diacritic sensitive searches
(slower document loads and larger database files).
trailing-wildcard-searches
-
Enable trailing wildcard searches
(slower document loads and larger database files).
trailing-wildcard-word-positions
-
Index word positions
for trailing-wildcard searches
only when trailing-wildcard-searches are enabled
(slower document loads and larger database files).
three-character-searches
-
Enable wildcard searches
and faster character-based XQuery predicates
using three or more characters
(slower document loads and larger database files).
three-character-word-positions
-
Index word positions
for three-character searches
only when three-character-searches are enabled
(slower document loads and larger database files).
two-character-searches
-
Enable wildcard searches
and faster character-based XQuery predicates
using two character
(slower document loads and larger database files).
one-character-searches
-
Enable wildcard searches
and faster character-based XQuery predicates
using one character
(slower document loads and larger database files).
word-lexicons
-
A list of word lexicons. Each lexicon is defined by its collation uri.
This is a complex element with the following element children:
word-lexicon
-
Maintain a lexicon of words (slower document loads and larger
database files).
included-elements
-
The elements included in the field.
This is a complex element with the following element children:
included-element
-
The element included in the field.
This is a complex element with the following element children:
namespace-uri
-
A namespace URI.
localname
-
One or more localnames.
weight
-
The weight, used to boost or lower relevance scores.
attribute-namespace-uri
-
Namespace of the child attribute.
attribute-localname
-
Localname of the child attribute.
attribute-value
-
Include or Exclude only elements with the specified attribute having this value.
excluded-elements
-
The elements excluded from the field.
This is a complex element with the following element children:
excluded-element
-
The element excluded from the field.
This is a complex element with the following element children:
namespace-uri
-
A namespace URI.
localname
-
One or more localnames.
attribute-namespace-uri
-
Namespace of the child attribute.
attribute-localname
-
Localname of the child attribute.
attribute-value
-
Include or Exclude only elements with the specified attribute having this value.
tokenizer-overrides
This is a complex element with the following element children:
tokenizer-override
This is a complex element with the following element children:
character
-
The character to override.
tokenizer-class
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/databases/Documents?view=config
==> Returns configuration information on the Documents database.
|
|
|
|
GET /manage/v2/databases/{id|name}?view=counts
|
|
 |
Summary:
This resource address returns the count information for forests attached
to the named database. The database can be identified either by id or name.
|
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.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK), and the
response body contains the requested data.
|
Usage Notes:
The count information includes the document count, directory count,
active fragment count, deleted fragment count, and nascent fragment count.
The structure of the data
returned is as follows: A database-counts element with the following element children:
id
-
The database id.
name
-
The database name.
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element children:
error-type
- The kind of error.
error-name
- The name of the error.
error-code
- The error identifier.
error-message
- The error text.
count-properties
- The statistics about the database.
This is a complex element with the following element children: documents- The number of documents in the database.
directories- The number of directories in the database.
active-fragments- The number of fragments in active use in the database.
deleted-fragments- The number of fragments marked for deletion in the database.
nascent-fragments- The number of nascent fragments in the database.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/databases/Documents?view=counts
==> Returns counts information on the forests attached to the
Documents database.
|
|
|
|
GET /manage/v2/databases/{id|name}?view=package
|
|
 |
Summary:
This resource address returns configuration details about the named
database in a format suitable for use with the
/manage/v2/packages interfaces. The database can be identifed
either by id or name.
|
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.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK), and the
response body contains the requested data.
|
Usage Notes:
You can request a package view as HTML, XML, or JSON, but only the
XML and JSON formats can be used as input to the
/manage/v2/packages interfaces, such as
POST /manage/v2/packages/{pkgname}.
|
Example:
http://localhost:8002/manage/v2/databases/Documents?view=package
==> Returns the package representation of the Documents database
|
|
|
|
GET /manage/v2/databases/{id|name}?view=status
|
|
 |
Summary:
This resource address returns status information for the named
database. The database can be identified either by id or name.
|
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.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK), and the
response body contains the requested data.
|
Usage Notes:
The structure of the data
returned is as follows: A database-status element with the following element children:
id
-
The database id.
name
-
The database name.
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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-properties
- The operating characteristics of the database.
This is a complex element with the following element children: enabled-
Is the forest enabled or not.
state- The state of the database.
forests-count- The number of forests for the database.
device-space- The amount of space left on the device.
data-size- The total size of the database on disk.
large-data-size- The total size of the large data on disk.
fast-data-size- The total size of the fast storage on disk.
in-memory-size- The total memory used for the database.
merge-count- The maximum number of forests that are merging.
total-merge-size- The total size of active forest merging for the database.
reindex-count- The total number of reindexing forests for the database.
backup-count- The maximum number of forests that are backing up.
restore-count- The maximum number of forests that are restoring.
min-capacity- The least capacity for a forest as a percentage.
load-properties- The load properties of the database.
This is a complex element with the following element children:
total-load
- The sum of the processing load factors
in seconds per second.
load-detail
- The detailed load characteristics for the database.
This is a complex element with the following element children:
query-read-load
-
The moving average of the read load on the query, in seconds per second.
This is summed for all of the contributing threads.
journal-write-load
-
The moving average of the load for writing to the journal, in
seconds per second. This is summed for all of the threads
writing on the host.
save-write-load
-
The moving average of the load for writing to in-memory stands, in
seconds per second. This is summed for all of the threads
writing on the host.
merge-read-load
-
The moving average of the read load on the merge, in seconds per second.
This is summed for all of the contributing threads.
merge-write-load
-
The moving average of the load for writing for merges, in
seconds per second. This is summed for all of the threads
writing on the host.
backup-read-load
-
The moving average of the read load on the backup, in seconds per
second. This is summed for all of the contributing threads.
backup-write-load
-
The moving average of the load for writing for backups, in
seconds per second. This is summed for all of the threads
writing on the host.
restore-read-load
-
The moving average of the read load on the backup, in seconds per
second. This is summed for all of the contributing threads.
restore-write-load
-
The moving average of the load for writing for restores, in
seconds per second. This is summed for all of the threads
writing on the host.
large-read-load
-
The moving average of the read load on large documents, in seconds per
second.
large-write-load
-
The moving average of the load for writing for large documents, in
seconds per second.
database-replication-send-load
-
The moving average of the load for sending data for database replication, in
seconds per second.
database-replication-receive-load
-
The moving average of the load for receiving data for database replication, in
seconds per second.
read-lock-wait-load
-
The read lock wait load, summed across all forests on the host.
read-lock-hold-load
-
The read lock hold load, summed across all forests on the host.
write-lock-wait-load
-
The write lock wait load, summed across all forests on the host.
write-lock-hold-load
-
The write lock hold load, summed across all forests on the host.
deadlock-wait-load
-
The deadlock wait load, summed across all forests on the host.
rate-properties- The rate properties of the database.
This is a complex element with the following element children:
total-rate
- The sum of the processing rate factors
in seconds per second.
rate-detail
- The detailed rate characteristics for the database.
This is a complex element with the following element children:
query-read-rate
-
The moving average of reading query data from disk, in megabytes
per second.
journal-write-rate
-
The moving average of writing data to the journal, in megabytes
per second.
save-write-rate
-
The moving average of writing data to in-memory stands, in megabytes
per second.
merge-read-rate
-
The moving average of reading merge data from disk, in megabytes
per second.
merge-write-rate
-
The moving average of writing data for merges, in megabytes
per second.
backup-read-rate
-
The moving average of reading backup data from disk, in megabytes
per second.
backup-write-rate
-
The moving average of writing data for backups, in megabytes
per second.
restore-read-rate
-
The moving average of reading restore data from disk, in megabytes
per second.
restore-write-rate
-
The moving average of writing data for restores, in megabytes
per second.
large-read-rate
-
The moving average of reading large documents from disk, in megabytes
per second.
large-write-rate
-
The moving average of writing data for large documents, in megabytes
per second.
database-replication-send-rate
-
The moving average of sending data for database replication, in megabytes
per second.
database-replication-receive-rate
-
The moving average of receiving data for database replication, in megabytes
per second.
read-lock-rate
-
The rate of taking read locks, summed across all forests on the host.
write-lock-rate
-
The rate of taking write locks, summed across all forests on the host.
deadlock-rate
-
The rate of taking write locks, summed across all forests on the host.
cache-properties- The cache properties of the database.
This is a complex element with the following element children:
list-cache-hit-rate
-
The average number of hits on the list cache.
list-cache-miss-rate
-
The average number of misses on the list cache.
triple-cache-hit-rate
-
The average number of hits on the list cache.
triple-cache-miss-rate
-
The average number of misses on the list cache.
triple-value-cache-hit-rate
-
The average number of hits on the list cache.
triple-value-cache-miss-rate
-
The average number of misses on the list cache.
compressed-tree-cache-hit-rate
-
The average number of hits on the compressed cache.
compressed-tree-cache-miss-rate
-
The average number of misses on the compressed cache.
list-cache-ratio
large-binary-cache-hit-rate
-
The average number of hits on the large binary cache.
large-binary-cache-miss-rate
-
The average number of misses on the large binary cache.
triple-cache-ratio
triple-value-cache-ratio
compressed-tree-cache-ratio
local-disk-failover- The failover properties of the database.
This is a complex element with the following element children:
local-disk-failover-active
- Whether the database has failover
to forests on the local disk.
replicas
- The number of the forests
for failover to the local disk.
replica-on-disk-size
- The total size on disk of the forests
for failover to the local disk.
replica-in-memory-size
- The total size in memory of the forests
for failover to the local disk.
failed-masters
- The total number of replica forests
for failover to the local disk.
active-replicas
- The total number of forests that are actively replicating
for failover to the local disk.
wait-replication
- The total number of forests that are waiting to replicate
for failover to the local disk.
database-replication-status- The database replication properties of the database.
This is a complex element with the following element children:
database-replication-configured
- Whether database replication is configured.
database-replication-active
- Whether all forests are replicating to corresponding
forests.
local-forests
- Count of local forests
is-foreign-replica
- Whether the local forest is a replica of a
foreign forest.
foreign-replica-databases
- Count of configured foreign replica databases.
foreign-replica-forests
- Count of foreign replica forests.
foreign-forests-lag-exceeded
- Count of foreign forests where reported lag exceeds
configured lag.
flexible-replication-enabled- Whether flexible replication
is enabled.
cpf-enabled- Whether CPF (the Content Processing Framework)
is enabled.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/databases/Documents?view=status
==> Returns status information on the Documents database.
|
|
|
|
GET /manage/v2/databases/{id|name}/partitions
|
|
 |
Summary:
Retrieve a list of partitions in a database.
|
Parameters:
format
:
The format of the data in the response body. Can be either
html, json, or xml. Use this
parameter to override the Accept header.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic server returns status code 200 (OK) and the
response body contains the list of partitions, in the requested format.
|
Usage Notes:
The structure of the data
returned is as follows: A partition-list element with the following element children:
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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-items
- Items of this resource type.
This is a complex element with the following element children: list-count- The number of items of this resource type.
list-item- An item of this resource type.
This is a complex element with the following element children:
uriref
- The path for 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.
item-summary
- A brief summary of the partition.
This is a complex element with the following element children:
forest-count
range
-
Range configuration for the range assignment policy.
This is a complex element with the following element children:
lower-bound
-
The lower bound of the range on the forest.
upper-bound
-
The upper bound of the range on the forest.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/databases/Documents/partitions
(: Returns a list of the partitions in the database Documents. :)
|
|
|
|
POST /manage/v2/databases/{id|name}/partitions
|
|
 |
Summary:
Add a partition to the database.
|
Parameters:
format
:
The format of the data in the request body. Can be either
json, or xml. Use this parameter to override
the Content-type header.
|
|
Request Headers:
Content-type:
The MIME type of the data in the request body. If the format
parameter is present, it takes precedence over this header. Accepted
values: application/xml, application/json.
|
|
Response Headers:
Location:
A reference to the newly created partition with which you can construct
a URL for the resource that is usable in subsequent requests. For
example, /manage/v2/databases/your-db-id/partitions/your-partition-name.
|
|
Required Privilege:
This operation requires the manage-admin role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage-admin
|
Response:
Upon success, MarkLogic server returns status code 201 (Created).
|
Usage Notes:
You must define the partition key and assignment policy of the
database before creating a partition. For details, see
'Configuring a Database to Participate in Tiered Storage' in the Administrator's Guide.
The partition configuration in the POST body must contain at least the
partition-name, lower-bound,
upper-bound, forests-per-host, and
host elements or keys. For more details and a list
of available options,
see tieredstorage:partition-create.
The structure of the data in the request body is as follows:
A partition element with the following element children:
partition-name
- Name of the partition.
upper-bound
-
The upper bound of the range on the forest.
lower-bound
-
The lower bound of the range on the forest.
forests-per-host
- Number of forests to distribute per host.
hosts
- A list of hosts.
This is a complex element with the following element children: host- A host name or id.
replicas
- Number of forests to allocate to each host for partition creation.
data-directory
-
The optional public directory for forests.
large-data-directory
-
The optional directory for large objects in a forest.
fast-data-directory
-
The optional smaller but faster directory for forests.
options
- A list of options.
This is a complex element with the following element children: option- An option.
|
Example:
The following configuration shows all possible fields.
$ cat add-partition.xml
<partition xmlns="http://marklogic.com/manage">
<partition-name>2011</partition-name>
<lower-bound>2011-01-01</lower-bound>
<upper-bound>2011-12-31</upper-bound>
<forests-per-host>1</forests-per-host>
<hosts>
<host>host-1</host>
<host>host-2</host>
</hosts>
<data-directory></data-directory>
<large-data-directory></large-data-directory>
<fast-data-directory></fast-data-directory>
<options>
<option>failover=none</option>
</options>
</partition>
$ curl --anyauth --user user:password -X POST -d @./add-partition.xml \
-i -H "Content-type: application/xml" \
http://localhost:8002/manage/v2/databases/example-db/partitions
==> A new partition named "2011" is created for example-db.
Forests 2011-0001 and 2011-0002 are created, one on each
named host. MarkLogic Server responds with headers similar to
the following.
HTTP/1.1 201 Created
Cache-Control: no-cache
Expires: -1
Location: /manage/v2/databases/13475778675412262560/partitions/2011
Server: MarkLogic
Set-Cookie: SessionID=d647d71d2ffc55d6; path=/
Content-Length: 0
Connection: Keep-Alive
Keep-Alive: timeout=5
|
Example:
$ cat add-partition.json
{
"partition-name": "2012",
"lower-bound": "2012-01-01",
"upper-bound": "2012-12-31",
"forests-per-host": 1,
"host": [ "host-1", "host-2" ],
"option": [ "failover=none" ]
}
$ curl --anyauth --user user:passowrd -X POST -d @./add-partition.json \
-i -H "Content-type: application/json"
http://localhost:8002/manage/v2/databases/example-db/partitions
==> A new partition named "2012" is created for example-db.
Forests 2012-0001 and 2012-0002 are created, one on each
named host. MarkLogic Server responds with headers similar to
the following.
HTTP/1.1 201 Created
Cache-Control: no-cache
Expires: -1
Location: /manage/v2/databases/13475778675412262560/partitions/2012
Server: MarkLogic
Set-Cookie: SessionID=53f1ed9b18ed7196; path=/
Content-Length: 0
Connection: Keep-Alive
Keep-Alive: timeout=5
|
|
|
|
DELETE /manage/v2/databases/{id|name}/partitions/{name}
|
|
 |
Summary:
Delete the partition identified by {name} from the database
identified by {id|name}.
|
Parameters:
delete-data
:
Whether or not to also delete the data in the partition. Default: false.
When this parameter is false, the partition configuration is deleted
but any data stored in the forests is preserved on disk.
|
|
Required Privilege:
This operation requires the manage-admin role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage-admin
|
Response:
MarkLogic server returns status code 204 (No Content).
|
Usage Notes:
If delete-data is false, only configuration information is
deleted. If delete-data is true, both configuration and the
forest contents are deleted. For details, see
admin:forest-delete.
|
Example:
$ curl --anyauth --user user:password -X DELETE -i \
http://localhost:8002/manage/v2/databases/example-db/partitions/2011
==> The partition named 2011 is deleted. The data it contained remains.
MarkLogic Server responds with headers similar to the following:
HTTP/1.1 204 No Content
Server: MarkLogic
Content-Length: 0
Connection: Keep-Alive
Keep-Alive: timeout=5
|
|
|
|
GET /manage/v2/databases/{id|name}/partitions/{name}
|
|
 |
Summary:
Retrieve a partition summary that includes links to related resources,
such as the containing database, member forests, and the partition
configuration.
|
Parameters:
format
:
The format of the data in the response body. Allowed values:
html, json, or xml. Use this
parameter to override the Accept header.
|
|
Request Headers:
Accept*:
The desired MIME type of the data in the response body. If the
format parameter is present, it takes precedence over this
header. Supported values: application/xml (default),
application/json, text/html.
|
|
Response Headers:
Content-type*:
The MIME type of the data in the response body. Use the Accept header
or format request parameter to specify a preferred format.
The format parameter takes precedence over the Accept
header if both are present.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic server returns status code 200 (OK) and the
response body contains the partition summary, in the requested format.
|
Usage Notes:
The structure of the data
returned is as follows: A partition-default element with the following element children:
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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.
assignment-policy
-
The policy to use for assignment and rebalancing.
This is a complex element with the following element children: assignment-policy-name-
What policy to use for assignment and rebalancing.
partition-key-
The partition key of the range assignment policy.
This is a complex element with the following element children:
cts:base-reference
lower-bound-included-
If this is true, ranges on all forests in this database include the
lower bound but not the upper bound (i.e., [lower-bound, upper-bound));
if this is false, ranges on all forests include the upper bound
but not the lower bound (i.e., (lower-bound, upper-bound]).
range
-
Range configuration for the range assignment policy.
This is a complex element with the following element children: lower-bound-
The lower bound of the range on the forest.
upper-bound-
The upper bound of the range on the forest.
partition-forest
This is a complex element with the following element children: forest-name-
The forest name.
host- A host name or id.
data-directory-
The optional public directory for forests.
large-data-directory-
The optional directory for large objects in a forest.
fast-data-directory-
The optional smaller but faster directory for forests.
forest-replicas- Replica forest definitions.
This is a complex element with the following element children:
forest-replica
- Replica forest definition.
This is a complex element with the following element children:
replica-name
- Name of the replica forest.
host
- A host name or id.
data-directory
-
The optional public directory for forests.
large-data-directory
-
The optional directory for large objects in a forest.
fast-data-directory
-
The optional smaller but faster directory for forests.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/databases/example-db/partitions/2011
(: Returns information about the partition 2011 in the database example-db. :)
|
|
|
|
PUT /manage/v2/databases/{id|name}/partitions/{name}
|
|
 |
Summary:
Invoke an operation on a partition, such as resizing the partition or
transferring or migrating the partition to a different database.
|
Parameters:
format
:
The format of the data in the request body. Allowed values:
json, or xml. Use this parameter to override
the Content-type header.
|
|
Request Headers:
Accept*:
The expected MIME type of the response. If the format
parameter is present, it takes precedence over the Accept header.
Supported values: application/xml,
application/json.
|
Content-type:
The MIME type of the data in the request body. If the format
parameter is present, it takes precedence over this header. Accepted
values: application/xml, application/json.
|
|
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, either
application/xml or application/json.
|
Location:
If the requested operation is asynchronous, a reference to the process
status view of the ticket associated with the asynchronous operation.
For example, /manage/v2/tickets/6495501889018785567?view=process-status.
This information is also available in the response body.
|
|
Required Privilege:
This operation requires the manage-admin role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage-admin
|
Response:
The response depends on the requested operation. The synchronous
transfer operation returns status code 200 (OK) upon success. The
asynchronous resize and migrate operations return status code 202
(Accepted) and a response body that includes a link to the process
status view for the affected resource.
|
Usage Notes:
The operation performed by the request is determined by the wrapper
element name in XML or the value of the operation key
in JSON. The following operations are supported: resize,
transfer, and migrate.
For details on the operations, see
tieredstorage:partition-resize,
tieredstorage:partition-migrate,
tieredstorage:partition-transfer, and
'Common Forest and Partition Operations' in the Administrator's Guide.
This method can be either synchronous or asynchronous, depending on
the type of operation: Resize and migrate are asynchronous operations,
transfer is a synchronous operation.
Asynchronous operations return status 202 (Accepted) and the response
Location header contains a reference to a ticket you can use to
check on the status and outcome of the operation using
GET /manage/v2/tickets/{tid}. Synchronous operations
return status 204 (No Content).
For the transfer operation, the input data structure
contains a destination-database. For details, see the
examples. Before transferring a partition from one database to another,
you must configure the destination database to have a matching range
policy.
For the migrate operation, the request body must be a
structure similar to that for resize, but omitting
forests-per-host. You must include at least the
host list. All other fields are optional,
except that JSON input must include operation.
For the resize operation, the request body must have
the following structure. You must include the host
list and forests-per-host. All other fields are optional,
except that JSON input must include operation.
A resize element with the following element children:
operation
- The partition operation to perform (resize, migrate, transfer).
forests-per-host
- Number of forests to distribute per host.
hosts
- A list of hosts.
This is a complex element with the following element children: host- A host name or id.
data-directory
-
The optional public directory for forests.
large-data-directory
-
The optional directory for large objects in a forest.
fast-data-directory
-
The optional smaller but faster directory for forests.
options
- A list of options.
This is a complex element with the following element children: option- An option.
|
Example:
The following is the minimum configuration information needed
to resize a partition. You can also include data-directory,
large-data-directory, fast-data-directory, and options.
$ cat partition-resize.xml
<resize xmlns="http://marklogic.com/manage">
<forests-per-host>2</forests-per-host>
<hosts>
<host>host-1</host>
<host>host-2</host>
</hosts>
</resize>
The equivalent JSON configuration:
$ cat partition-resize.json
{
"operation": "resize",
"forests-per-host": 2,
"host": [ "host-1", "host-2" ]
}
$ curl --anyauth --user user:password -X PUT -d @./partition-resize.xml \
-i -H "Content-type: application/xml" \
http://localhost:8002/manage/v2/databases/example-db/partitions/2011
==> The partition named "2011" is resized such that it has 2 forests on
each host. New forests are created as needed. Since the operation
is asynchronous, MarkLogic Server responds with ticket information
similar to the following:
HTTP/1.1 202 Accepted
Content-type: application/xml
Cache-Control: no-cache
Expires: -1
Location: /manage/v2/tickets/14991169073676404304?view=process-status
Server: MarkLogic
Content-Length: 246
Connection: Keep-Alive
Keep-Alive: timeout=5
<resize xmlns="http://marklogic.com/manage">
<link>
<kindref>process-status</kindref>
<uriref>/manage/v2/tickets/14991169073676404304?view=process-status</uriref>
</link>
<message>Monitor operation progress by viewing ticket</message>
</resize>
|
Example:
$ cat partition-transfer.xml
<transfer xmlns="http://marklogic.com/manage">
<destination-database>destination-db</destination-database>
</transfer>
$ cat partition-transfer.json
{
"operation": "transfer",
"destination-database": "destination-db"
}
$ curl --anyauth --user user:password -X PUT -d @./partition-transfer.xml \
-i -H "Content-type: application/xml" \
http://localhost:8002/manage/v2/databases/source-db/partitions/2011
==> The partition named "2011" is transferred from source-db to
destination-db. New forests are created in destination-db. The
forests in the partition in destination-db are detached from the
database. This is a synchronous operation. MarkLogic Server responds
with headers similar to the following:
HTTP/1.1 204 No Content
Server: MarkLogic
Content-Length: 0
Connection: Keep-Alive
Keep-Alive: timeout=5
|
Example:
The following is the minimum configuration information needed
to resize a partition. You can also include data-directory,
large-data-directory, fast-data-directory, and options.
$ cat partition-migrate.xml
<migrate xmlns="http://marklogic.com/manage">
<hosts>
<host>dest-host-1</host>
<host>dest-host-2</host>
</hosts>
</migrate>
The equivalent JSON configuration:
$ cat partition-resize.json
{
"operation": "migrate",
"host": [ "dest-host-1", "dest-host-2" ]
}
$ curl --anyauth --user user:password -X PUT -d @./partition-migrate.xml \
-i -H "Content-type: application/xml" \
http://localhost:8002/manage/v2/databases/example-db/partitions/2011
==> The partition named "2011" is migrated to the hosts dest-host-1
and dest-host-2. This is an asynchronous operation. MarkLogic Server
Server responds with ticket information similar to the following:
HTTP/1.1 202 Accepted
Content-type: application/xml
Cache-Control: no-cache
Expires: -1
Location: /manage/v2/tickets/14991169073676404304?view=process-status
Server: MarkLogic
Content-Length: 246
Connection: Keep-Alive
Keep-Alive: timeout=5
<migrate xmlns="http://marklogic.com/manage">
<link>
<kindref>process-status</kindref>
<uriref>/manage/v2/tickets/14991169073676404304?view=process-status</uriref>
</link>
<message>Monitor operation progress by viewing ticket</message>
</migrate>
|
|
|
|
GET /manage/v2/databases/{id|name}/partitions/{name}/properties
|
|
 |
Summary:
Retrieve the current configuration for the partition identified by
{name} in the database identified by {name|id}.
|
Parameters:
format?
:
The format of the returned data. Can be html,
json, or xml (default). If present, the
format parameter overrides the Accept header.
|
|
Request Headers:
Accept*:
The expected MIME type of the response. If the format
parameter is present, it takes precedence over the Accept header.
Allowed values: application/xml,
application/json, and text/html.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK), and
the response body contains the requested information.
|
Usage Notes:
The structure of the data
returned is as follows: A partition-properties element with the following element children:
availability
-
Availability of the forest data.
updates-allowed
-
The kinds of updates that should be allowed for this forest.
|
Example:
http://localhost:8002/manage/v2/databases/example-db/partitions/2012/properties
(: Returns summary of the partition named 2012 in the database example-db. :)
|
|
|
|
PUT /manage/v2/databases/{id|name}/partitions/{name}/properties
|
|
 |
Summary:
Modify the configuration of the partition identified by {name}
in the database identified by {id|name}.
|
Request Headers:
Content-type:
The MIME type of the data in the request body. Supported values:
application/xml, application/json.
|
|
Required Privilege:
This operation requires the manage-admin role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage-admin
|
Response:
Upon success, MarkLogic Server returns a status code 204 (No Content).
|
Usage Notes:
You can set the property values as follows:
For details, see
'Common Forest and Partition Operations' in the Administrator's Guide.
The structure of the data
returned is as follows: A partition-properties element with the following element children:
availability
-
Availability of the forest data.
updates-allowed
-
The kinds of updates that should be allowed for this forest.
|
Example:
$ cat partition-prop.xml
<partition-properties xmlns="http://marklogic.com/manage">
<availability>online</availability>
<updates-allowed>all</updates-allowed>
</partition-properties>
$ cat partition-prop.json
{
"availability": "online",
"updates-allowed": all"
}
$ curl --anyauth --user user:password -X PUT -d @./partition-prop.xml \
-i -H "Content-type: application/xml" \
http://localhost:8002/manage/v2/databases/example-db/partitions/2011/properties
==> Set the availability and updates-allowed properties of the partition
named 2011 of the database example-db. MarkLogic Server responds
with status code 204 (No Content) and headers similar to the following:
HTTP/1.1 204 No Content
Server: MarkLogic
Content-Length: 0
Connection: Keep-Alive
Keep-Alive: timeout=5
|
|
|
|
GET /manage/v2/databases/{id|name}/rebalancer
|
|
 |
Summary:
This resource address returns the current rebalancer configuration.
|
Parameters:
format
:
The format of the returned data. Can be either html,
json, or xml (default). This value overrides
the Accept header.
|
|
Request Headers:
Accept*:
The expected MIME type of the response. If the format
parameter is present, it takes precedence over the Accept header.
Supported values: application/xml,
application/json.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic server returns status code 200 (OK) and the
response body contains the requested in information as XML, JSON, or
HTML, depending upon the format parameter or Accept header.
|
Usage Notes:
The structure of the data
returned is as follows: A database-rebalancer-properties element with the following element children:
rebalancer-enable
-
Enable automatic rebalancing after configuration changes.
rebalancer-throttle
-
Larger numbers mean work harder at rebalancing.
|
Example:
$ curl --anyauth --user user:password -X GET -i -H "Accept: application/xml" \
http://localhost:8002/manage/v2/databases/example-db/rebalancer
HTTP/1.1 200 OK
Content-type: application/xml
Cache-Control: no-cache
Expires: -1
Server: MarkLogic
Content-Length: 310
Connection: Keep-Alive
Keep-Alive: timeout=5
<database-rebalancer-properties
xsi:schemaLocation="http://marklogic.com/manage manage.xsd"
xmlns="http://marklogic.com/manage"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<rebalancer-enable>true</rebalancer-enable>
<rebalancer-throttle>5</rebalancer-throttle>
</database-rebalancer-properties>
|
Example:
$ curl --anyauth --user user:password -X GET -i -H "Accept: application/json" \
http://localhost:8002/manage/v2/databases/example-db/rebalancer
HTTP/1.1 200 OK
Content-type: application/json
Cache-Control: no-cache
Expires: -1
Server: MarkLogic
Content-Length: 51
Connection: Keep-Alive
Keep-Alive: timeout=5
{
"rebalancer-enable":true,
"rebalancer-throttle":5
}
|
|
|
|
PUT /manage/v2/databases/{id|name}/rebalancer
|
|
 |
Summary:
Update the rebalancer configuration for a database.
|
Request Headers:
Content-type:
The MIME type of the data in the request body. Supported values:
application/xml, application/json.
|
|
Required Privilege:
This operation requires the manage-admin role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage-admin
|
Response:
Upon success, MarkLogic Server returns status code 204 (No Content).
|
Usage Notes:
You can modify the following configuration settings:
rebalancer-enable: Set to true or false to
enable or disable the rebalancer on this database. For details,
see admin:database-set-rebalancer-enable.
rebalancer-throttle: Set the rebalancer throttle
to control the priority of performing rebalancing on the database.
Higher numbers give rebalancing a higher priority and system
resource allocation. For details, see
admin:database-set-rebalancer-throttle.
You can include one or more properties in the input configuration.
Properties not included are unchanged. For details, see
'Database Rebalancing' in the Administrator's Guide.
The structure of the data in the request body is as follows:
A database-rebalancer-properties element with the following element children:
rebalancer-enable
-
Enable automatic rebalancing after configuration changes.
rebalancer-throttle
-
Larger numbers mean work harder at rebalancing.
|
Example:
$ cat reb-config.xml
<database-rebalancer-properties xmlns="http://marklogic.com/manage"
<rebalancer-enable>true</rebalancer-enable>
<rebalancer-throttle>5</rebalancer-throttle>
</database-rebalancer-properties>
$ cat reb-config.json
{
"rebalancer-enable":true,
"rebalancer-throttle":5
}
$ curl --anyauth --user user:password -X PUT -d @./reb-config.xml \
-i -H "Accept: application/xml" \
http://localhost:8002/manage/v2/databases/example-db/rebalancer
==> The rebalancer configuration is modified. MarkLogic Server returns
status code 204 (No Content) and headers similar to the following:
HTTP/1.1 204 No Content
Server: MarkLogic
Content-Length: 0
Connection: Keep-Alive
|
|
|
|
GET /manage/v2/databases/{id|name}/sub-databases
|
|
 |
Summary:
Retrieve a list of sub-databases of the database identified by
{id|name}.
|
Parameters:
format?
:
The format of the data in the response body. Allowed values:
html, json, or xml (default).
Use this parameter to override the Accept header.
|
|
Request Headers:
Accept*:
The desired MIME type of the data in the response body. If the
format parameter is present, it takes precedence over this
header. Supported values: application/xml (default),
application/json, text/html.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic server returns status code 200 (OK) and the
response body contains the requested data.
|
Usage Notes:
The structure of the data
returned is as follows: A sub-database-list element with the following element children:
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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-items
- Items of this resource type.
This is a complex element with the following element children: list-count- The number of items of this resource type.
list-item- An item of this resource type.
This is a complex element with the following element children:
uriref
- The path for 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.
item-summary
- A brief summary of the partition.
This is a complex element with the following element children:
forest-count
range
-
Range configuration for the range assignment policy.
This is a complex element with the following element children:
lower-bound
-
The lower bound of the range on the forest.
upper-bound
-
The upper bound of the range on the forest.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/databases/example-db/sub-databases
(: Returns a summary of the sub-databases of the database example-db. :)
|
|
|
|
POST /manage/v2/databases/{id|name}/sub-databases
|
|
 |
Summary:
Create a new database attached as sub-database of the database identified
by {id|name}.
|
Request Headers:
Content-type:
The MIME type of the data in the request body. Supported values:
application/xml, application/json.
|
|
Response Headers:
Location:
A reference to the newly created database, suitable for retrieving
configuration and status information using the Management API. For
example, if a requests creates a database named "subdb":
/manage/v2/databases/15326391285115269194/sub-databases/subdb.
|
|
Required Privilege:
This operation requires the manage-admin role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage-admin
|
Response:
Upon success, MarkLogic server returns status code 201 (Created).
|
Usage Notes:
You can set the kind element of the input configuration to
either active or archive.
For details, see
tieredstorage:database-create-sub-database and
'Sub-databases and Super-databases' in the Administrator's Guide.
The structure of the data in the request body is as follows:
A sub-database element with the following element children:
database-name
-
The database name.
kind
- The kind of sub-database (active, archive).
|
Example:
$ cat subdb-create.xml
<sub-database xmlns="http://marklogic.com/manage">
<database-name>sub-1</database-name>
<kind>active</kind>
</sub-database>
$ curl --anyauth --user user:password -X POST -d @./subdb-create.xml \
-i -H "Content-type: application/xml" \
http://localhost:8002/manage/v2/databases/super-db/sub-databases
==> Create a database named sub-1 and make a sub-database of super-db.
MarkLogic Server responds with status code 201 (Created) and headers
similar to the following:
HTTP/1.1 201 Created
Content-type: application/xml
Cache-Control: no-cache
Expires: -1
Server: MarkLogic
Content-Length: 0
Connection: Keep-Alive
Keep-Alive: timeout=5
|
Example:
$ cat subdb-create.json
{
"database-name": "sub-1",
"kind": "active"
}
$ curl --anyauth --user user:password -X POST -d @./subdb-create.json \
-i -H "Content-type: application/json" \
http://localhost:8002/manage/v2/databases/super-db/sub-databases
==> Create a database named sub-1 and make a sub-database of super-db.
MarkLogic Server responds with status code 201 (Created) and headers
similar to the following:
HTTP/1.1 201 Created
Content-type: application/xml
Cache-Control: no-cache
Expires: -1
Server: MarkLogic
Content-Length: 0
Connection: Keep-Alive
Keep-Alive: timeout=5
|
|
|
|
GET /manage/v2/databases/{id|name}/super-databases
|
|
 |
Summary:
Retrieve a list of super-databases of which the specified database
is a sub-database.
|
Parameters:
format?
:
The format of the data in the response body. Allowed values:
html, json, or xml (default).
Use this parameter to override the Accept header.
|
|
Request Headers:
Accept*:
The desired MIME type of the data in the response body. If the
format parameter is present, it takes precedence over this
header. Supported values: application/xml (default),
application/json, text/html.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic server returns status code 200 (OK) and the
response body contains the requested data.
|
Usage Notes:
For details, see
admin:database-super-databases and
'Sub-databases and Super-databases' in the Administrator's Guide.
The structure of the data
returned is as follows: A super-database-list element with the following element children:
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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-items
- Items of this resource type.
This is a complex element with the following element children: list-count- The number of items of this resource type.
list-item- An item of this resource type.
This is a complex element with the following element children:
uriref
- The path for 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.
item-summary
- A brief summary of the partition.
This is a complex element with the following element children:
forest-count
range
-
Range configuration for the range assignment policy.
This is a complex element with the following element children:
lower-bound
-
The lower bound of the range on the forest.
upper-bound
-
The upper bound of the range on the forest.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/sub-db/super-databases
(: Retrieve a summary of the super databases of sub-db. :)
|
|
|
|
POST /manage/v2/databases/{id|name}/super-databases
|
|
 |
Summary:
Create a new database and make it a super-database of the database
identified by {id|name}.
|
Request Headers:
Content-type:
The MIME type of the data in the request body. Supported values:
application/xml, application/json.
|
|
Response Headers:
Location:
A reference to the newly created database that can be used to construct
a URL for the resource that is usable in subsequent requests. For
example, /manage/v2/databases/15326391285115269194/super-databases/superdb.
|
|
Required Privilege:
This operation requires the manage-admin role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage-admin
|
Response:
Upon success, MarkLogic server returns status code 201 (Created).
|
Usage Notes:
The new super-database inherits the configuration of the sub-database
on whose behalf it was created.
For details, see
tieredstorage:database-create-super-database and
[xref name="admin/tiered-storage"].
The structure of the data in the request body is as follows:
A super-database element with the following element children:
database-name
-
The database name.
|
Example:
$ cat superdb-create.xml
<super-database xmlns="http://marklogic.com/manage">
<database-name>super-db</database-name>
</super-database>
$ curl --anyauth --user user:password -X POST -d @./superdb-create.xml \
-i -H "Content-type: application/xml" \
http://localhost:8002/manage/v2/databases/sub-2/super-databases
==> Create a database named super-db and make it the super-database of sub-2.
MarkLogic Server responds with status code 201 (Created) and headers
similar to the following:
HTTP/1.1 201 Created
Content-type: application/xml
Cache-Control: no-cache
Expires: -1
Server: MarkLogic
Content-Length: 0
Connection: Keep-Alive
Keep-Alive: timeout=5
|
Example:
$ cat superdb-create.json
{
"database-name": "super-db",
}
$ curl --anyauth --user user:password -X POST -d @./superdb-create.json \
-i -H "Content-type: application/json" \
http://localhost:8002/manage/v2/databases/sub-2/super-databases
==> Create a database named super-db and make the super-database of sub-2.
MarkLogic Server responds with status code 201 (Created) and headers
similar to the following:
HTTP/1.1 201 Created
Content-type: application/xml
Cache-Control: no-cache
Expires: -1
Server: MarkLogic
Content-Length: 0
Connection: Keep-Alive
Keep-Alive: timeout=5
|
|
|
|
DELETE /manage/v2/databases/{sub-id|name}/super-databases/{super-id|name}
|
|
 |
Summary:
Disassociate a super-database from a sub-database and delete the
super-database.
|
Required Privilege:
This operation requires the manage-admin role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage-admin
|
Response:
MarkLogic server returns status code 204 (No Content).
|
Usage Notes:
|
Example:
$ curl --anyauth --user user:password -X DELETE -i \
http://localhost:8002/manage/v2/databases/sub-db/super-databases/super-db
==> The super-database super-db of database sub-db is deleted. MarkLogic Server
responds with output similar to the following:
HTTP/1.1 204 No Content
Server: MarkLogic
Content-Length: 0
Connection: Keep-Alive
Keep-Alive: timeout=5
|
|
|
|
GET /manage/v2/databases/{sub-id|name}/super-databases/{super-id|name}
|
|
 |
Summary:
Retrieve a summary about a specific super-database of a sub-database.
|
Parameters:
format?
:
The format of the data in the response body. Allowed values:
html, json, or xml (default).
Use this parameter to override the Accept header.
|
|
Request Headers:
Accept*:
The desired MIME type of the data in the response body. If the
format parameter is present, it takes precedence over this
header. Supported values: application/xml (default),
application/json, text/html.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic server returns status code 200 (OK) and the
response body contains the requested data.
|
Usage Notes:
For details, see
admin:database-sub-databases and
'Sub-databases and Super-databases' in the Administrator's Guide.
The structure of the data
returned is as follows: A super-database-default element with the following element children:
id
-
The database id.
name
-
The database name.
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/databases/sub-2/super-databases/super-db
(: Retrieve a summary about super-db, a super database of sub-2. :)
|
|
|
|
DELETE /manage/v2/databases/{super-id|name}/sub-databases/{sub-id|name}
|
|
 |
Summary:
Disassociate a sub-database from a super-database and delete the
sub-database.
|
Required Privilege:
This operation requires the manage-admin role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage-admin
|
Response:
MarkLogic server returns status code 204 (No Content).
|
Usage Notes:
|
Example:
$ curl --anyauth --user user:password -X DELETE -i \
http://localhost:8002/manage/v2/databases/super-db/sub-databases/sub-db
==> The sub-database sub-db of database super-db is deleted. MarkLogic Server
responds with output similar to the following:
HTTP/1.1 204 No Content
Server: MarkLogic
Content-Length: 0
Connection: Keep-Alive
Keep-Alive: timeout=5
|
|
|
|
GET /manage/v2/databases/{super-id|name}/sub-databases/{sub-id|name}
|
|
 |
Summary:
Retrieve a summary of the specified sub-database, including a list of
sibling sub-databases, if any.
|
Parameters:
format?
:
The format of the data in the response body. Allowed values:
html, json, or xml (default).
Use this parameter to override the Accept header.
|
|
Request Headers:
Accept*:
The desired MIME type of the data in the response body. If the
format parameter is present, it takes precedence over this
header. Supported values: application/xml (default),
application/json, text/html.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic server returns status code 200 (OK) and the
response body contains the requested data.
|
Usage Notes:
For details, see
admin:database-sub-databases and
'Sub-databases and Super-databases' in the Administrator's Guide.
The structure of the data
returned is as follows: A sub-database-default element with the following element children:
id
-
The database id.
name
-
The database name.
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/databases/super-db/sub-databases/sub-1
(: A summary of the database sub-1, which is a sub-database of super-db. :)
|
|
|
|
|
 |
Summary:
This resource address returns data about the forests in the cluster.
The data returned depends on the view. If no view
is specified, this request returns a summary of the forests
in the cluster.
|
Parameters:
format?
:
The format of the returned data. Can be either html,
json, or xml. This value overrides
the Accept header if both are present.
|
view?
:
A specific view of the returned data. Can be either schema,
counts, storage, metrics,
default, or status.
|
database-id?
:
Returns a summary of the forests for the specified database. The database
can be identified either by id or name.
|
group-id?
:
Returns a summary of the forests for the specified group. The group
can be identified either by id or name.
|
host-id?
:
Returns a summary of the forests for the specified host. The host
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.
Supported values: application/xml,
application/json, text/html.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
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:
A forest-default-list element with the following element children:
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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-items
- Items of this resource type.
This is a complex element with the following element children: list-count- The number of items of this resource type.
list-item- An item of this resource type.
This is a complex element with the following element children:
uriref
- The path for 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.
item-summary
This is a complex element with the following element children:
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/forests
(: Returns a summary of the forests in the cluster. :)
|
Example:
http://localhost:8002/manage/v2/forests?view=storage
(: Returns a storage view of the forests in the cluster. :)
|
|
|
|
|
 |
Summary:
Create a new forest, including replicas if specified. If a database
id or database is included, attach the new forest(s) to the database.
|
Request Headers:
Content-Type:
The MIME type of the data in the request body, either
application/xml or application/json.
|
|
Required Privilege:
This operation requires the manage-admin role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage-admin
|
Response:
Upon successful completion, MarkLogic Server returns status code 201
(Created).
|
Usage Notes:
The payload can specify either replica forests or failover hosts,
but not both. If replicas are specified in the POST body, then
replication is enabled by default.
Newly created forests are enabled by default.
Setting range boundaries for the forest in the POST body does not
modify the configuration of the database to which the forest is
attached.
The structure of the data in the POST body is shown below. You must
include at least forest-name and host.
If replicas are included, the configuration data for each replica must
include at least replica-name and host.
A forest-create element with the following element children:
forest-name
-
The forest name.
host
- A host name or id.
database
data-directory
-
The optional public directory for forests.
large-data-directory
-
The optional directory for large objects in a forest.
fast-data-directory
-
The optional smaller but faster directory for forests.
availability
-
Availability of the forest data.
rebalancer-enable
-
Enable automatic rebalancing after configuration changes.
range
-
Range configuration for the range assignment policy.
This is a complex element with the following element children: lower-bound-
The lower bound of the range on the forest.
upper-bound-
The upper bound of the range on the forest.
failover-hosts
- A list of hosts for shared disk failover.
This is a complex element with the following element children: failover-host- A host name or id for shared disk failover.
forest-replicas
- Replica forest definitions.
This is a complex element with the following element children: forest-replica- Replica forest definition.
This is a complex element with the following element children:
replica-name
- Name of the replica forest.
host
- A host name or id.
data-directory
-
The optional public directory for forests.
large-data-directory
-
The optional directory for large objects in a forest.
fast-data-directory
-
The optional smaller but faster directory for forests.
|
Example:
$ cat forest-create.xml
<forest-create xmlns="http://marklogic.com/manage">
<forest-name>example-1</forest-name>
<host>my-host</host>
</forest-create>
$ curl --anyauth --user user:password -X POST -d @./forest-create.xml \
-i -H "Content-type: application/xml" \
http://localhost:8002/manage/v2/forests
==> Create a forest named "example-1" on host "my-host". MarkLogic Server
responds with output similar to the following. You can use the
reference in the Location header to retrieve status and other
information about the new forest.
HTTP/1.1 201 Created
Location: /manage/v2/forests/2721944172534009539
Content-type: application/xml
Cache-Control: no-cache
Expires: -1
Server: MarkLogic
Content-Length: 0
Connection: Keep-Alive
Keep-Alive: timeout=5
|
Example:
$ cat forest-create.json
{
"forest-name": "example-2",
"host": "my-host",
"database": "Documents"
}
$ curl --anyauth --user user:password -X POST -d @./forest-create.xml \
-i -H "Content-type: application/json" \
http://localhost:8002/manage/v2/forests
==> Create a forest named "example-2" on host "my-host", and attach it
to the Documents database. MarkLogic Server responds with headers
similar to the following. You can use the reference in the Location
header to retrieve status and other information about the new forest.
HTTP/1.1 201 Created
Location: /manage/v2/forests/2721944172534009539
Content-type: application/xml
Cache-Control: no-cache
Expires: -1
Server: MarkLogic
Content-Length: 0
Connection: Keep-Alive
Keep-Alive: timeout=5
|
|
|
|
|
 |
Summary:
Perform an operation on one or more forests, such as combining
multiple forests into a single new one, or migrating the data in the
forests to a new data directory.
|
Parameters:
format?
:
The format of the returned data. Can be either html,
json, or xml. This value overrides
the Accept header if both are present.
|
|
Request Headers:
Accept*:
The expected MIME type of the response. If the format
parameter is present, it takes precedence over the Accept header.
Supported values: application/xml,
application/json.
|
Content-Type:
The MIME type of the data in the request body, either
application/xml or application/json.
|
|
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, either
application/xml or application/json.
|
|
Required Privilege:
This operation requires the manage-admin role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage-admin
|
Response:
Upon successful completion, MarkLogic Server returns status code 202
(Accepted) and ticket information you can use to check on the
operation status.
|
Usage Notes:
The operation performed by the request is determined by the wrapper
element name in XML or the value of the operation key
in JSON. The following operations are supported:
forest-combine and forest-migrate.
The operations performed by this request are asynchronous. If your
request is accepted, MarkLogic Server returns ticket information that
can be used with GET /manage/v2/tickets to check on the status and
eventual outcome of your request.
The forest-combine operation combines multiple forests into
one new forest. The source forests are required to be either all in "open"
or "open-replica" state or all in "sync replicating" state. If a forest's
state changes during the combine operation, an error may be thrown. If
all source forests are in "open" or "open replica" state and are all
attached to a database, the combined forest will be attached to the
database and the source forests (or their masters) detached to the database.
For the forest-combine operation, you must include the
list of forests to combine (forest), the destination
forest name (forest-name), and the host of the
destination forest (host). In JSON, define the operation
by setting operation to "forest-combine".
The forest-migrate operation moves data in one or more forests
to new data directories and optionally sets a new host for the
destination.
For the forest-migrate operation, you must include the
list of forests to migrate (forest) and the destination
host. In JSON, define the operation by setting operation
to "forest-migrate".
For both operations, you can optionally specify
data-directory, large-data-directory,
fast-data-directory, and options. For a list of options, see
tieredstorage:forest-combine or
tieredstorage:forest-migrate.
For details, see
'Common Forest and Partition Operations' in the Administrator's Guide.
The data in the request body for forest-combine has
the following structure. The structure for forest-migrate is
similar, except it does not include forest-name.
A forest-combine element with the following element children:
forests
- A list of forests.
This is a complex element with the following element children: forest- A host forset or id.
host
- A host name or id.
forest-name
-
The forest name.
data-directory
-
The optional public directory for forests.
large-data-directory
-
The optional directory for large objects in a forest.
fast-data-directory
-
The optional smaller but faster directory for forests.
options
- A list of options.
This is a complex element with the following element children: option- An option.
|
Example:
$ cat forest-combine.xml
<forest-combine xmlns="http://marklogic.com/manage">
<forests>
<forest>example-1</forest>
<forest>example-2</forest>
</forests>
<forest-name>new-forest</forest-name>
<host>my-host</host>
</forest-combine>
$ cat forest-combine.json
{
"operation": "forest-combine",
"forest": [ "example-1", "example-2" ],
"forest-name": "new-forest",
"host": "my-host"
}
$ curl --anyauth --user user:password -X PUT -d @./forest-combine.xml \
-i -H "Content-type: application/xml" \
http://localhost:8002/manage/v2/forests
==> Combine forests example-1 and example-2 into a new forest named
"new-forest" on my-host. MarkLogic Server responds with output
similar to the following. This is an asynchronous operation. To
check the status or outcome, use the reference in the Location header
or the uriref.
HTTP/1.1 202 Accepted
Location: /manage/v2/tickets/6699732791380391489?view=process-status
Content-type: application/xml
Cache-Control: no-cache
Expires: -1
Server: MarkLogic
Content-Length: 218
Connection: Keep-Alive
Keep-Alive: timeout=5
<forest-combine>
<link>
<kindref>process-status</kindref>
<uriref>/manage/v2/tickets/6699732791380391489?view=process-status</uriref>
</link>
<message>Monitor operation progress by viewing ticket</message>
</forest-combine>
$ curl --anyauth --user user:password -X GET -i -H "Accept: application/xml" \
http://localhost:8002/manage/v2/tickets/6699732791380391489?view=process-status
==> MarkLogic Server returns the status of this forest-combine operation.
For details, see GET /manage/v2/tickets/{id}.
<ticket-process-status xmlns="http://marklogic.com/manage/tickets">
<id>6699732791380391489</id>
...
<status-properties>
<status>completed</status>
<start-time>2013-09-21T12:02:54.866173-07:00</start-time>
<ticket-expiration>2013-09-28T12:02:54.866173-07:00</ticket-expiration>
<database>App-Services</database>
...
<time-consumed>PT41.128523S</time-consumed>
<errors>0</errors>
...
</status-properties>
...
</ticket-process-status>
|
Example:
$ cat forest-migrate.xml
<forest-migrate xmlns="http://marklogic.com/manage">
<forests>
<forest>example-1</forest>
<forest>example-2</forest>
</forests>
<host>my-host</host>
</forest-combine>
$ cat forest-migrate.json
{
"operation": "forest-migrate",
"forest": ["example-1", "example-2"],
"host": "my-host"
}
$ curl --anyauth --user user:password -X PUT -d @./forest-combine.xml \
-i -H "Content-type: application/xml" \
http://localhost:8002/manage/v2/forests
==> Migrate forests example-1 and example-2 to "my-host". MarkLogic
Server responds with output similar to the following. This is
an asynchronous operation. To check the status or outcome, use the
reference in the Location header or the uriref.
HTTP/1.1 202 Accepted
Location: /manage/v2/tickets/6699732791380391489?view=process-status
Content-type: application/xml
Cache-Control: no-cache
Expires: -1
Server: MarkLogic
Content-Length: 218
Connection: Keep-Alive
Keep-Alive: timeout=5
<forest-migrate>
<link>
<kindref>process-status</kindref>
<uriref>/manage/v2/tickets/6699732791380391489?view=process-status</uriref>
</link>
<message>Monitor operation progress by viewing ticket</message>
</forest-migrate>
|
|
|
|
GET /manage/v2/forests?view=metrics
|
|
 |
Summary:
Retrieve historical monitoring data about the forests in the cluster.
|
Parameters:
format?
:
The format of the returned data. Can be either html,
json, or xml. This value overrides
the Accept header if both are present.
|
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.
Supported values: application/xml,
application/json, text/html.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK). The
response body contains the requested data.
|
Example:
http://localhost:8002/manage/v2/forests?view=metrics
(: Returns historical monitoring data about the forests in the cluster. :)
|
|
|
|
GET /manage/v2/forests?view=status
|
|
 |
Summary:
This resource address returns status information about the forests
in the cluster.
|
Parameters:
format?
:
The format of the returned data. Can be either html,
json, or xml. This value overrides
the Accept header if both are present.
|
database-id?
:
Returns a summary of the forests for the specified database. The database
can be identified either by id or name.
|
group-id?
:
Returns a summary of the forests for the specified group. The group
can be identified either by id or name.
|
host-id?
:
Returns a summary of the forests for the specified host. The host
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.
Supported values: application/xml,
application/json, text/html.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK). The
response body contains the requested data.
|
Usage Notes:
The structure of the data
returned is as follows: A forest-status-list element with the following element children:
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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
- Status summary for the forests in the list.
This is a complex element with the following element children: total-forests- The total number of forests.
state-not-open- The number of forests that aren't open.
max-stands-per-forest- The maximum number of stands for a forest.
merge-count- The maximum number of forests that are merging.
backup-count- The maximum number of forests that are backing up.
restore-count- The maximum number of forests that are restoring.
min-capacity- The least capacity for a forest as a percentage.
load-properties- The load properties of the forest.
This is a complex element with the following element children:
total-load
- The sum of the processing load factors
in seconds per second.
load-detail
- The detailed load characteristics for the forest.
This is a complex element with the following element children:
query-read-load
-
The moving average of the read load on the query, in seconds per second.
This is summed for all of the contributing threads.
journal-write-load
-
The moving average of the load for writing to the journal, in
seconds per second. This is summed for all of the threads
writing on the host.
save-write-load
-
The moving average of the load for writing to in-memory stands, in
seconds per second. This is summed for all of the threads
writing on the host.
merge-read-load
-
The moving average of the read load on the merge, in seconds per second.
This is summed for all of the contributing threads.
merge-write-load
-
The moving average of the load for writing for merges, in
seconds per second. This is summed for all of the threads
writing on the host.
backup-read-load
-
The moving average of the read load on the backup, in seconds per
second. This is summed for all of the contributing threads.
backup-write-load
-
The moving average of the load for writing for backups, in
seconds per second. This is summed for all of the threads
writing on the host.
restore-read-load
-
The moving average of the read load on the backup, in seconds per
second. This is summed for all of the contributing threads.
restore-write-load
-
The moving average of the load for writing for restores, in
seconds per second. This is summed for all of the threads
writing on the host.
large-read-load
-
The moving average of the read load on large documents, in seconds per
second.
large-write-load
-
The moving average of the load for writing for large documents, in
seconds per second.
database-replication-send-load
-
The moving average of the load for sending data for database replication, in
seconds per second.
database-replication-receive-load
-
The moving average of the load for receiving data for database replication, in
seconds per second.
read-lock-wait-load
-
The read lock wait load, summed across all forests on the host.
read-lock-hold-load
-
The read lock hold load, summed across all forests on the host.
write-lock-wait-load
-
The write lock wait load, summed across all forests on the host.
write-lock-hold-load
-
The write lock hold load, summed across all forests on the host.
deadlock-wait-load
-
The deadlock wait load, summed across all forests on the host.
rate-properties- The rate properties of the forest.
This is a complex element with the following element children:
total-rate
- The sum of the processing rate factors
in seconds per second.
rate-detail
- The detailed rate characteristics for the forest.
This is a complex element with the following element children:
query-read-rate
-
The moving average of reading query data from disk, in megabytes
per second.
journal-write-rate
-
The moving average of writing data to the journal, in megabytes
per second.
save-write-rate
-
The moving average of writing data to in-memory stands, in megabytes
per second.
merge-read-rate
-
The moving average of reading merge data from disk, in megabytes
per second.
merge-write-rate
-
The moving average of writing data for merges, in megabytes
per second.
backup-read-rate
-
The moving average of reading backup data from disk, in megabytes
per second.
backup-write-rate
-
The moving average of writing data for backups, in megabytes
per second.
restore-read-rate
-
The moving average of reading restore data from disk, in megabytes
per second.
restore-write-rate
-
The moving average of writing data for restores, in megabytes
per second.
large-read-rate
-
The moving average of reading large documents from disk, in megabytes
per second.
large-write-rate
-
The moving average of writing data for large documents, in megabytes
per second.
database-replication-send-rate
-
The moving average of sending data for database replication, in megabytes
per second.
database-replication-receive-rate
-
The moving average of receiving data for database replication, in megabytes
per second.
read-lock-rate
-
The rate of taking read locks, summed across all forests on the host.
write-lock-rate
-
The rate of taking write locks, summed across all forests on the host.
deadlock-rate
-
The rate of taking write locks, summed across all forests on the host.
cache-properties- The cache properties of the forest.
This is a complex element with the following element children:
list-cache-hit-rate
-
The average number of hits on the list cache.
list-cache-miss-rate
-
The average number of misses on the list cache.
triple-cache-hit-rate
-
The average number of hits on the list cache.
triple-cache-miss-rate
-
The average number of misses on the list cache.
triple-value-cache-hit-rate
-
The average number of hits on the list cache.
triple-value-cache-miss-rate
-
The average number of misses on the list cache.
compressed-tree-cache-hit-rate
-
The average number of hits on the compressed cache.
compressed-tree-cache-miss-rate
-
The average number of misses on the compressed cache.
list-cache-ratio
triple-cache-ratio
triple-value-cache-ratio
compressed-tree-cache-ratio
large-binary-cache-hit-rate
-
The average number of hits on the large binary cache.
large-binary-cache-miss-rate
-
The average number of misses on the large binary cache.
status-list-items
- The forests reflected in the status summary.
This is a complex element with the following element children: status-list-item- A forest reflected in the status summary.
This is a complex element with the following element children:
uriref
- The path for a resource or list of resources.
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 element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/forests?view=status
(: Returns a status summary of the forests in the cluster. :)
|
Example:
http://localhost:8002/manage/v2/forests?view=status&database-id=Documents
(: Returns a status view of the forests in the Documents database. :)
|
|
|
|
GET /manage/v2/forests?view=storage
|
|
 |
Summary:
This resource address returns storage information about the forests
in the cluster.
|
Parameters:
format?
:
The format of the returned data. Can be either html,
json, or xml. This value overrides
the Accept header if both are present.
|
database-id?
:
Returns a summary of the forests for the specified database. The database
can be identified either by id or name.
|
group-id?
:
Returns a summary of the forests for the specified group. The group
can be identified either by id or name.
|
host-id?
:
Returns a summary of the forests for the specified host. The host
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.
Supported values: application/xml,
application/json, text/html.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK). The
response body contains the requested data.
|
Usage Notes:
The structure of the data
returned is as follows: A forest-storage-list element with the following element children:
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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.
storage-list-items
- The list of hosts that have storage for forests.
This is a complex element with the following element children: storage-host- A host that has storage for forests.
This is a complex element with the following element children:
relation
- A specific related resource.
This is a complex element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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 resource related to the host.
locations
- The list of locations on the host that have forests.
This is a complex element with the following element children:
location
- A location on the host that has forests.
This is a complex element with the following element children:
path
-
The path of the stand.
capacity
- The percentage of storage space that is free.
device-space
-
The amount of space left on forest device.
fast-forest-size
- The total fast storage for forests in MB.
forest-reserve
-
The amount of space needed for merging.
forest-size
- The total ordinary storage for forests in MB.
large-data-size
-
The amount of space large objects take up on disk.
remaining-space
- The total free storage for forests in MB.
location-forests
- The list of forests at the location on the host.
This is a complex element with the following element children:
location-forest
- A forest at the location on the host.
This is a complex element with the following element children:
relation
- A specific related resource.
This is a complex element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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 resource related to the host.
uriref
- The path for a resource or list of resources.
idref
- The numeric identifier for the resource.
nameref
- The name of the resource.
disk-size
-
The amount of space the stand takes on disk.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/forests?view=storage
(: Returns a storage summary of the forests in the cluster. :)
|
|
|
|
DELETE /manage/v2/forests/{id|name}
|
|
 |
Summary:
Delete a forest.
|
Parameters:
level
:
The type of state change to initiate. Allowed values: full,
config-only.
|
|
Required Privilege:
This operation requires the manage-admin role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage-admin
|
Response:
Upon successful completion, MarkLogic Server returns status code 204
(No Content). If the forest does not exist, MarkLogic Server returns
status code 204 (No Content). If the forest exists but cannot be
deleted for some reason, such as it is still attached to a database,
the request fails and returns status code 400 (Bad Request).
|
Usage Notes:
A config-only deletion removes only the forest configuration;
the data contained in the forest remains on disk. A full
deletion removes both the forest configuration and the data.
|
Example:
$ curl --anyauth --user user:password -X DELETE -i \
http://localhost:8002/manage/v2/forests/example?level=full
==> The forest named "example" is deleted, along with all of the data
it contained. MarkLogic Server responds with headers similar to
the following:
HTTP/1.1 204 No Content
Server: MarkLogic
Content-Length: 0
Connection: Keep-Alive
Keep-Alive: timeout=5
|
|
|
|
GET /manage/v2/forests/{id|name}
|
|
 |
Summary:
Retrieve information about a forest. The forest can be identified
either by id or name.
|
Parameters:
format?
:
The format of the returned data. Can be either html,
json, or xml (default). This parameter
is not meaningful with view=edit. This value overrides
the Accept header if both are present.
|
view?
:
A specific view of the returned data. Can be either default,
config, counts, edit,
or status.
Default: default.
|
property
:
This parameter returns a specific count value when using
view=counts. The value can be any first-level child
element of the count-properties element.
You can include multiple property parameters in this
resource address.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
For all views except edit, upon success, MarkLogic
Server returns status code 200 (OK), and the response body contains
the requested data. If view=edit, MarkLogic Server
responds with status code 302 (Found) and the Location header contains
a redirect to the appropriate page in the Admin Interface.
|
Usage Notes:
The counts view includes the stand count, document count, directory count,
reindex refragment fragment count, reindex fragment count, and
refragment document count.
The structure of the data in the response for the default view is
as follows:
A forest-default element with the following element children:
id
-
A forest unique ID (64-bit value).
name
-
The forest name.
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/forests/Documents
==> Returns the default information on the Documents forest.
|
Example:
http://localhost:8002/manage/v2/forests/Documents?view=config&format=json
==> Returns configuration information about the Documents forest, as JSON.
|
Example:
http://localhost:8002/manage/v2/forests/Documents?view=counts&property=document-count
==> Returns count information for the document-count property.
|
|
|
|
POST /manage/v2/forests/{id|name}
|
|
 |
Summary:
Initiate a state change on a forest, such as a merge, restart, or attach.
|
Parameters:
state
:
The type of state change to initiate. Allowed values: clear,
merge, restart, attach,
detach, retire, employ. Specify
this parameter as form data in the POST body.
|
database?
:
A database name or database id. Include this parameter for operations
that logically require a database, such as state=attach.
Specify this parameter as form data in the POST body.
|
|
Request Headers:
Content-Type?:
The MIME type of the data in the request body. The only supported
value is application/x-www-form-urlencoded.
|
|
Required Privilege:
This operation requires the manage-admin role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage-admin
|
Response:
Upon successful completion, MarkLogic Server returns status code 202
(Accepted).
|
Example:
$ curl --anyauth --user user:password -X POST -i \
-d "state=attach" -d "database=Documents" \
-H "Content-type: application/x-www-form-urlencoded" \
http://localhost:8002/manage/v2/forests/example
==> The forest named example is attached to the Documents database.
MarkLogic Server responds with headers similar to the following:
HTTP/1.1 200 OK
Content-type: application/xml
Cache-Control: no-cache
Expires: -1
Server: MarkLogic
Content-Length: 0
Connection: Keep-Alive
Keep-Alive: timeout=5
|
|
|
|
GET /manage/v2/forests/{id|name}?view=config
|
|
 |
Summary:
Retrieve configuration information about the named forest.
|
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.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK), and the
response body contains the requested data.
|
Usage Notes:
The structure of the data
returned is as follows: A forest-config element with the following element children:
id
-
A forest unique ID (64-bit value).
name
-
The forest name.
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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.
config-properties
- The configuration properties of the forest.
This is a complex element with the following element children: enabled-
Forest enabled status.
data-directory-
The optional public directory for forests.
large-data-directory-
The optional directory for large objects in a forest.
fast-data-directory-
The optional smaller but faster directory for forests.
updates-allowed-
The kinds of updates that should be allowed for this forest.
availability-
Availability of the forest data.
rebalancer-enable-
Enable automatic rebalancing after configuration changes.
range-
Range configuration for the range assignment policy.
This is a complex element with the following element children:
lower-bound
-
The lower bound of the range on the forest.
upper-bound
-
The upper bound of the range on the forest.
failover-enable-
Enable assignment to a failover host if the primary host is down.
forest-backups-
Backups scheduled for this forest.
This is a complex element with the following element children:
forest-backup
-
A scheduled forest backup.
This is a complex element with the following element children:
backup-directory
-
The backup directory pathname.
backup-type
-
What type of backup is this.
backup-period
-
How often this backup should run (every n months, weeks, days, hours or minutes).
backup-month-day
-
The day of the month that this backup happens.
backup-days
-
The days that this backup happens.
This is a complex element with the following element children:
backup-day
-
A day that this backup occurs.
backup-start-date
-
The starting date (in MM/DD/YYYY notation) for a one-time backup
backup-start-time
-
The starting time (in 24:00 notation).
backup-timestamp
-
The date and time this backup was created.
forest-replicas-
A list of replica forests, used for local-disk failover.
This is a complex element with the following element children:
forest-replica
-
The unique key of a forest.
database-replication-
Database replication configuration.
This is a complex element with the following element children:
foreign-replicas
-
Foreign replicas of this database.
This is a complex element with the following element children:
foreign-replica
-
Foreign replica of this database.
This is a complex element with the following element children:
relation
- A specific related resource.
This is a complex element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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 resource related to the host.
foreign-database-id
-
A foreign database ID.
foreign-forest-id
-
A foreign forest ID.
foreign-master
-
Foreign master for this database.
This is a complex element with the following element children:
relation
- A specific related resource.
This is a complex element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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 resource related to the host.
foreign-database-id
-
A foreign database ID.
foreign-forest-id
-
A foreign forest ID.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/forests/my-forest-1&view=config
==> Returns the configuration information on the forest named my-forest-1.
|
|
|
|
GET /manage/v2/forests/{id|name}?view=counts
|
|
 |
Summary:
Retrieve count information about a forest. The forest can be identified
either by id or name.
|
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.
|
property
:
This parameter returns a specific count value. The value can be any
first-level child element of the count-properties element.
You can include multiple property parameters in this
resource address.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK), and the
response body contains the requested data.
|
Usage Notes:
The counts view includes the stand count, document count, directory count,
reindex refragment fragment count, reindex fragment count, and
refragment document count.
The structure of the data
returned is as follows: A forest-counts element with the following element children:
id
-
A forest unique ID (64-bit value).
name
-
The forest name.
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element children:
error-type
- The kind of error.
error-name
- The name of the error.
error-code
- The error identifier.
error-message
- The error text.
count-properties
- The statistics about the forest.
This is a complex element with the following element children: error-
The error in processing forest status.
rebalancer-error-
The error in rebalancing.
stands-counts-
The counts of stands.
This is a complex element with the following element children:
stand-counts
-
The stand's counts.
This is a complex element with the following element children:
stand-id
-
The unique key of a stand.
path
-
The path of the stand.
active-fragment-count
-
The number of fragments.
nascent-fragment-count
-
The number of nascent fragments.
deleted-fragment-count
-
The number of deleted fragments.
document-count-
The number of documents in the forest.
directory-count-
The number of directories in the forest.
reindex-refragment-fragment-count-
The number of fragments that need to be reindexed or refragmented.
reindex-refragment-rate-
The rate of reindexing/refragmenting.
forced-reindex-fragment-count-
The number of fragments that need to be reindexed due for forced
reindexing.
reindex-fragment-count-
The number of fragments that need to be reindexed.
reindex-previous-versions-count-
The number of fragments that need previous versions (used with
point-in-time queries) reindexed.
reindex-stemmed-searches-count-
The number of fragments that need basic stemmed search reindexed.
reindex-word-searches-count-
The number of fragments that need word searches reindexed.
reindex-one-character-searches-count-
The number of fragments that need one-character searches reindexed.
reindex-two-character-searches-count-
The number of fragments that need two-character searches reindexed.
reindex-three-character-searches-count-
The number of fragments that need three-character searches reindexed.
reindex-fast-phrase-searches-count-
The number of fragments that need fast phrase searches reindexed.
reindex-fast-case-sensitive-searches-count-
The number of fragments that need fast case-sensitive searches
reindexed.
reindex-fast-element-word-searches-count-
The number of fragments that need element word searches reindexed.
reindex-fast-element-phrase-searches-count-
The number of fragments that need element phrase searches reindexed.
reindex-fast-element-character-searches-count-
The number of fragments that need element character searches reindexed.
reindex-fast-element-trailing-wildcard-searches-count-
The number of fragments that need element trailing wildcard
searches reindexed.
reindex-word-positions-count-
The number of fragments that need word positions reindexed.
reindex-scaled-log-tf-normalization-count-
The number of fragments that scaled log-tf normalization reindexed.
reindex-unscaled-log-tf-normalization-count-
The number of fragments that unscaled log-tf normalization reindexed.
reindex-element-word-positions-count-
The number of fragments that need element word positions reindexed.
reindex-element-value-positions-count-
The number of fragments that need element value positions reindexed.
reindex-attribute-value-positions-count-
The number of fragments that need attribute value positions reindexed.
reindex-field-value-searches-count-
The number of fragments that need field value searches reindexed.
reindex-field-value-positions-count-
The number of fragments that need field value positions reindexed.
reindex-three-character-word-positions-count-
The number of fragments that need three character word positions
reindexed.
reindex-triple-index-count-
The number of fragments that need triples reindexed.
reindex-triple-positions-count-
The number of fragments that need triple positions reindexed.
reindex-trailing-wildcard-searches-count-
The number of fragments that need trailing wildcard searches reindexed.
reindex-trailing-wildcard-word-positions-count-
The number of fragments that need trailing wildcard word positions
reindexed.
reindex-fast-diacritic-sensitive-searches-count-
The number of fragments that need fast diacritic-sensitive searches
reindexed.
reindex-word-lexicon-count-
The number of fragments that need the word lexicon reindexed.
reindex-binary-threshold-count-
The number of binary fragments that need to be reindexed for size threshold.
reindex-deleted-stemmed-searches-count-
The number of fragments that need the stemmed search indexes deleted.
reindex-deleted-word-searches-count-
The number of fragments that need the word search indexes deleted.
reindex-deleted-one-character-searches-count-
The number of fragments that need the one-character search
indexes deleted.
reindex-deleted-two-character-searches-count-
The number of fragments that need the two-character search
indexes deleted.
reindex-deleted-three-character-searches-count-
The number of fragments that need the three-character search
indexes deleted.
reindex-deleted-fast-phrase-searches-count-
The number of fragments that need the fast phrase search
indexes deleted.
reindex-deleted-fast-case-sensitive-searches-count-
The number of fragments that need the fast case-sensitive
search indexes deleted.
reindex-deleted-fast-element-word-searches-count-
The number of fragments that need the element word search
indexes deleted.
reindex-deleted-fast-element-phrase-searches-count-
The number of fragments that need the element phrase search
indexes deleted.
reindex-deleted-fast-element-character-searches-count-
The number of fragments that need the element character
search indexes deleted.
reindex-deleted-fast-element-trailing-wildcard-searches-count-
The number of fragments that need the element trailing wildcard
search indexes deleted.
reindex-deleted-word-positions-count-
The number of fragments that need the word position indexes deleted.
reindex-deleted-element-word-positions-count-
The number of fragments that need the element word position
indexes deleted.
reindex-deleted-element-value-positions-count-
The number of fragments that need the element value position
indexes deleted.
reindex-deleted-field-value-searches-count-
The number of fragments that need the field value search
indexes deleted.
reindex-deleted-field-value-positions-count-
The number of fragments that need the field value position
indexes deleted.
reindex-deleted-attribute-value-positions-count-
The number of fragments that need the attribute value position
indexes deleted.
reindex-deleted-three-character-word-positions-count-
The number of fragments that need the three-character word position
indexes deleted.
reindex-deleted-triple-index-count-
The number of fragments that need deleted triples reindexed.
reindex-deleted-triple-positions-count-
The number of fragments that need deleted triple positions reindexed.
reindex-deleted-trailing-wildcard-searches-count-
The number of fragments that need the trailing wildcard search
indexes deleted.
reindex-deleted-trailing-wildcard-word-positions-count-
The number of fragments that need the trailing wildcard word
position indexes deleted.
reindex-deleted-fast-diacritic-sensitive-searches-count-
The number of fragments that need the diacritic-sensitive
search indexes deleted.
reindex-uri-lexicon-count-
The number of fragments that need the URI lexicon reindexed.
reindex-deleted-uri-lexicon-count-
The number of fragments that need the URI lexicons deleted.
reindex-collection-lexicon-count-
The number of fragments that need the collection lexicon reindexed.
reindex-deleted-collection-lexicon-count-
The number of fragments that need the collection lexicons deleted.
reindex-element-word-query-throughs-
The reindexing of word query throughs.
This is a complex element with the following element children:
reindex-element-word-query-through
-
The reindexing of an element word query through.
This is a complex element with the following element children:
namespace-uri
-
A namespace URI.
localname
-
One or more localnames.
reindex-fragment-count
-
The number of fragments that need to be reindexed.
fragment-count
-
The total number of fragments for a given reindexing or rebalancing activity.
reindex-phrase-throughs-
The reindexing of phrase throughs.
This is a complex element with the following element children:
reindex-phrase-through
-
The reindexing of a phrase through.
This is a complex element with the following element children:
namespace-uri
-
A namespace URI.
localname
-
One or more localnames.
reindex-fragment-count
-
The number of fragments that need to be reindexed.
fragment-count
-
The total number of fragments for a given reindexing or rebalancing activity.
reindex-phrase-arounds-
The reindexing of phrase arounds.
This is a complex element with the following element children:
reindex-phrase-around
-
The reindexing of a phrase around.
This is a complex element with the following element children:
namespace-uri
-
A namespace URI.
localname
-
One or more localnames.
reindex-fragment-count
-
The number of fragments that need to be reindexed.
fragment-count
-
The total number of fragments for a given reindexing or rebalancing activity.
reindex-range-element-indexes-
The reindexing of range element-indexes.
This is a complex element with the following element children:
reindex-range-element-index
-
The reindexing of a range element index.
This is a complex element with the following element children:
namespace-uri
-
A namespace URI.
localname
-
One or more localnames.
scalar-type
-
The scalar type of a range index.
reindex-fragment-count
-
The number of fragments that need to be reindexed.
fragment-count
-
The total number of fragments for a given reindexing or rebalancing activity.
reindex-range-field-indexes-
The reindexing of range field-indexes.
This is a complex element with the following element children:
reindex-range-field-index
-
The reindexing of a range field index.
This is a complex element with the following element children:
field-name
-
The field name.
scalar-type
-
The scalar type of a range index.
reindex-fragment-count
-
The number of fragments that need to be reindexed.
fragment-count
-
The total number of fragments for a given reindexing or rebalancing activity.
reindex-range-path-indexes-
The reindexing of range path-indexes.
This is a complex element with the following element children:
reindex-range-path-index
-
The reindexing of a range path index.
This is a complex element with the following element children:
path-expression
-
The path expression.
scalar-type
-
The scalar type of a range index.
reindex-fragment-count
-
The number of fragments that need to be reindexed.
fragment-count
-
The total number of fragments for a given reindexing or rebalancing activity.
reindex-range-element-attribute-indexes-
The reindexing of range element attribute indexes.
This is a complex element with the following element children:
reindex-range-element-attribute-index
-
The reindexing of a range element attribute index.
This is a complex element with the following element children:
parent-namespace-uri
-
A namespace URI.
parent-localname
-
One or more localnames.
namespace-uri
-
A namespace URI.
localname
-
One or more localnames.
reindex-fragment-count
-
The number of fragments that need to be reindexed.
fragment-count
-
The total number of fragments for a given reindexing or rebalancing activity.
reindex-deleted-range-indexes-
The reindexing of removed range indexes.
This is a complex element with the following element children:
fragment-count
-
The total number of fragments for a given reindexing or rebalancing activity.
reindex-element-word-lexicons-
The reindexing of element word lexicons.
This is a complex element with the following element children:
reindex-element-word-lexicon
-
The reindexing of an element word lexicon.
This is a complex element with the following element children:
namespace-uri
-
A namespace URI.
localname
-
One or more localnames.
reindex-fragment-count
-
The number of fragments that need to be reindexed.
fragment-count
-
The total number of fragments for a given reindexing or rebalancing activity.
reindex-element-attribute-word-lexicons-
The reindexing of element attribute word lexicons.
This is a complex element with the following element children:
reindex-element-attribute-word-lexicon
-
The reindexing of an element attribute word lexicon.
This is a complex element with the following element children:
parent-namespace-uri
-
A namespace URI.
parent-localname
-
One or more localnames.
namespace-uri
-
A namespace URI.
localname
-
One or more localnames.
reindex-fragment-count
-
The number of fragments that need to be reindexed.
fragment-count
-
The total number of fragments for a given reindexing or rebalancing activity.
reindex-all-deleted-word-lexicons-
The reindexing of removed word lexicons.
This is a complex element with the following element children:
fragment-count
-
The total number of fragments for a given reindexing or rebalancing activity.
reindex-geospatial-element-indexes-
The reindexing of geospatial element indexes.
This is a complex element with the following element children:
reindex-geospatial-element-index
-
The reindexing of a geospatial element index.
This is a complex element with the following element children:
namespace-uri
-
A namespace URI.
localname
-
One or more localnames.
reindex-fragment-count
-
The number of fragments that need to be reindexed.
fragment-count
-
The total number of fragments for a given reindexing or rebalancing activity.
reindex-geospatial-element-child-indexes-
The reindexing of geospatial element child indexes.
This is a complex element with the following element children:
reindex-geospatial-element-child-index
-
The reindexing of a geospatial element child index.
This is a complex element with the following element children:
parent-namespace-uri
-
A namespace URI.
parent-localname
-
One or more localnames.
namespace-uri
-
A namespace URI.
localname
-
One or more localnames.
reindex-fragment-count
-
The number of fragments that need to be reindexed.
fragment-count
-
The total number of fragments for a given reindexing or rebalancing activity.
reindex-geospatial-element-pair-indexes-
The reindexing of geospatial element pair indexes.
This is a complex element with the following element children:
reindex-geospatial-element-pair-index
-
The reindexing of a geospatial element pair index.
This is a complex element with the following element children:
parent-namespace-uri
-
A namespace URI.
parent-localname
-
One or more localnames.
latitude-namespace-uri
-
A namespace URI.
latitude-localname
-
One or more localnames.
longitude-namespace-uri
-
A namespace URI.
longitude-localname
-
One or more localnames.
reindex-fragment-count
-
The number of fragments that need to be reindexed.
fragment-count
-
The total number of fragments for a given reindexing or rebalancing activity.
reindex-geospatial-element-attribute-pair-indexes-
The reindexing of geospatial element indexes.
This is a complex element with the following element children:
reindex-geospatial-element-attribute-pair-index
-
The reindexing of a geospatial element attribute pair index.
This is a complex element with the following element children:
parent-namespace-uri
-
A namespace URI.
parent-localname
-
One or more localnames.
latitude-namespace-uri
-
A namespace URI.
latitude-localname
-
One or more localnames.
longitude-namespace-uri
-
A namespace URI.
longitude-localname
-
One or more localnames.
reindex-fragment-count
-
The number of fragments that need to be reindexed.
fragment-count
-
The total number of fragments for a given reindexing or rebalancing activity.
refragment-document-count-
The number of documents that need to be refragmented.
refragment-fragment-roots-
The refragmenting of fragment roots.
This is a complex element with the following element children:
refragment-fragment-parent
-
The refragmenting of fragment parent.
This is a complex element with the following element children:
namespace-uri
-
A namespace URI.
localname
-
One or more localnames.
refragment-document-count
-
The number of documents that need to be refragmented.
document-count
-
The number of documents in the forest.
refragment-fragment-parents-
The refragmenting of fragment parents.
This is a complex element with the following element children:
refragment-fragment-parent
-
The refragmenting of fragment parent.
This is a complex element with the following element children:
namespace-uri
-
A namespace URI.
localname
-
One or more localnames.
refragment-document-count
-
The number of documents that need to be refragmented.
document-count
-
The number of documents in the forest.
refragment-new-fields-
The refragmenting of new fields.
This is a complex element with the following element children:
refragment-new-field
-
The refragmenting of a new field.
This is a complex element with the following element children:
field-name
-
The field name.
refragment-document-count
-
The number of documents that need to be refragmented.
document-count
-
The number of documents in the forest.
refragment-modified-fields-
The refragmenting of modifiedfields.
This is a complex element with the following element children:
refragment-modified-field
-
The refragmenting of a new field.
This is a complex element with the following element children:
field-name
-
The field name.
refragment-document-count
-
The number of documents that need to be refragmented.
document-count
-
The number of documents in the forest.
refragment-removed-configurations-
Refragmenting old fragment root/parent settings
This is a complex element with the following element children:
refragment-document-count
-
The number of documents that need to be refragmented.
reindex-reverse-searches-fragment-count-
The number of fragments that need to be reindexed for reverse searches.
rebalance-fragment-counts-
The number of fragments that need to be rebalanced out.
This is a complex element with the following element children:
rebalance-fragment-count
-
A destination and the number of fragments that need to be rebalanced to this destination.
This is a complex element with the following element children:
rebalance-destination
-
The destination of the rebalancing operation.
fragment-count
-
The total number of fragments for a given reindexing or rebalancing activity.
rebalance-rate-
The rate of rebalancing.
active-fragment-count-
The number of fragments.
deleted-fragment-count-
The number of deleted fragments.
nascent-fragment-count-
The number of nascent fragments.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/forests/my-forest?view=counts&property=document-count
==> Returns count information for the document-count property of my-forest.
|
|
|
|
GET /manage/v2/forests/{id|name}?view=status
|
|
 |
Summary:
Retrieve status information about the named forest.
|
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.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK), and the
response body contains the requested data.
|
Usage Notes:
The structure of the data
returned is as follows: A forest-status element with the following element children:
id
-
A forest unique ID (64-bit value).
name
-
The forest name.
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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-properties
- The operating characteristics of the forest.
This is a complex element with the following element children: state-
The state of the forest.
enabled-
Forest enabled status.
availability-
Availability of the forest data.
updates-allowed-
The kinds of updates that should be allowed for this forest.
rebalancer-enable-
Enable automatic rebalancing after configuration changes.
lower-bound-
The lower bound of the range on the forest.
upper-bound-
The upper bound of the range on the forest.
master-forest-
A forest unique ID (64-bit value).
replica-forests-
The replica forests.
This is a complex element with the following element children:
replica-forest
-
A forest unique ID (64-bit value).
current-master-forest-
A forest unique ID (64-bit value).
current-master-precise-time-
current-master-fsn-
error-
The error in processing forest status.
rebalancer-error-
The error in rebalancing.
last-state-change-
The last time the forest state changed.
nonblocking-timestamp-
The most current timestamp for which a query will execute without
waiting for transactions to settle.
data-dir-
The data directory.
large-data-dir-
The large data directory.
fast-data-dir-
The fast data directory.
journals-size-
The amount of space the journals take up on disk.
large-data-size-
The amount of space large objects take up on disk.
orphaned-binaries-
The count of orphaned large binaries.
stands-
The stands in the forest.
This is a complex element with the following element children:
stand
-
The stand of a forest.
This is a complex element with the following element children:
stand-id
-
The unique key of a stand.
path
-
The path of the stand.
stand-kind
-
The kind of stand.
is-fast
-
Is the stand in the fast data directory ?
label-version
-
The version number of the label file.
disk-size
-
The amount of space the stand takes on disk.
memory-size
-
The amount of space the stand takes in memory.
list-cache-hits
-
The number of hits on the list cache.
list-cache-misses
-
The number of misses on the list cache.
list-cache-hit-rate
-
The average number of hits on the list cache.
list-cache-miss-rate
-
The average number of misses on the list cache.
compressed-tree-cache-hits
-
The number of hits on the compressed cache.
compressed-tree-cache-misses
-
The number of misses on the compressed cache.
compressed-tree-cache-hit-rate
-
The average number of hits on the compressed cache.
compressed-tree-cache-miss-rate
-
The average number of misses on the compressed cache.
triple-cache-hits
-
The number of hits on the list cache.
triple-cache-misses
-
The number of misses on the list cache.
triple-cache-hit-rate
-
The average number of hits on the list cache.
triple-cache-miss-rate
-
The average number of misses on the list cache.
triple-value-cache-hits
-
The number of hits on the list cache.
triple-value-cache-misses
-
The number of misses on the list cache.
triple-value-cache-hit-rate
-
The average number of hits on the list cache.
triple-value-cache-miss-rate
-
The average number of misses on the list cache.
forest-reserve-
The amount of space needed for merging.
merges-
The merges in progress on the forest.
This is a complex element with the following element children:
merge
-
The merge of two stands in a forest.
This is a complex element with the following element children:
merge-id
-
A unique key for a merge.
canceled
-
Is a merge canceled or not.
input-stands
-
The input stands of a merge.
This is a complex element with the following element children:
stand-id
-
The unique key of a stand.
path
-
The path of the stand.
output-stand
-
The ID of a stand resulting from a merge.
start-time
-
The time a merge started.
final-size
-
The estimated final size of a stand.
current-size
-
The current size of a merging stand.
merge-rate
-
The rate of a merge (MB/sec).
rebalancing-
Is this forest rebalancing.
reindexing-
Is this forest reindexing.
device-space-
The amount of space left on forest device.
large-device-space-
The amount of space left on large forest device.
fast-device-space-
The amount of space left on fast forest device.
last-backup-
The last time the forest was backed up.
backups-
The backups in progress on the forest.
This is a complex element with the following element children:
backup
-
The backup of a forest.
This is a complex element with the following element children:
path
-
The path of the stand.
start-time
-
The time a merge started.
final-size
-
The estimated final size of a stand.
current-size
-
The current size of a merging stand.
journal-archiving
-
Is journal archiving enabled for the backup?
journal-archive-path
-
Path to the associated journal archive location.
journal-archive-lag-limit
-
Number of seconds the archived journal can lag the active journal.
last-restore-
The last time the forest was restored.
restore-
The restore of a forest.
This is a complex element with the following element children:
path
-
The path of the stand.
start-time
-
The time a merge started.
final-size
-
The estimated final size of a stand.
current-size
-
The current size of a merging stand.
restore-state
-
The state of the forest restore.
restore-to-time
-
The date and time this backup was created.
journal-archiving
-
Is journal archiving enabled for the backup?
journal-archive-path
-
Path to the associated journal archive location.
safe-restore-to-time
-
The safest timestamp closest to the restore-to-time at which the forest
is in a consistent state.
transaction-coordinators-
The set of transactions that this forest is coordinating.
This is a complex element with the following element children:
transaction-coordinator
-
A transaction that this forest is coordinating.
This is a complex element with the following element children:
transaction-id
-
The unique key of the transaction.
decision-state
-
The state of the transaction.
xid
-
The Xid.
This is a complex element with the following element children:
global-transaction-id
-
The global transaction ID of a Xid.
branch-qualifier
-
The branch qualifier of a Xid.
participants
-
The set of participating transactions.
This is a complex element with the following element children:
participant
-
A participating transaction.
This is a complex element with the following element children:
participant-id
-
The forest ID of a participant of a transaction.
participant-status
-
The state of the participating transaction.
size
-
The number of bytes taken up in the journal by this in-process
transaction information.
transaction-participants-
The set of transactions that this forest is participating in.
This is a complex element with the following element children:
transaction-participant
-
A transaction that this forest is participating in.
This is a complex element with the following element children:
transaction-id
-
The unique key of the transaction.
coordinator-id
-
The forest ID of the coordinator of a transaction.
size
-
The number of bytes taken up in the journal by this in-process
transaction information.
transaction-journal-size-
The number of bytes taken up in the journal by the in-process
transactions.
transaction-journal-limit-
The maximum number of bytes that can be taken up in the journal
by the in-process transactions.
query-read-bytes-
The number of bytes read off disk.
query-read-time-
The time (as xs:dayTimeDuration) to read query data from disk.
query-read-rate-
The moving average of reading query data from disk, in megabytes
per second.
query-read-load-
The moving average of the read load on the query, in seconds per second.
This is summed for all of the contributing threads.
journal-write-bytes-
The number of bytes written to the journal on disk.
journal-write-time-
The time (as xs:dayTimeDuration) to write data to the journal.
journal-write-rate-
The moving average of writing data to the journal, in megabytes
per second.
journal-write-load-
The moving average of the load for writing to the journal, in
seconds per second. This is summed for all of the threads
writing on the host.
save-write-bytes-
The number of bytes written when saving in-memory stands.
save-write-time-
The time (as xs:dayTimeDuration) spent saving in-memory stands.
save-write-rate-
The moving average of writing data to in-memory stands, in megabytes
per second.
save-write-load-
The moving average of the load for writing to in-memory stands, in
seconds per second. This is summed for all of the threads
writing on the host.
merge-read-bytes-
The number of bytes read during merges.
merge-read-time-
The time (as xs:dayTimeDuration) to read data for merges.
merge-read-rate-
The moving average of reading merge data from disk, in megabytes
per second.
merge-read-load-
The moving average of the read load on the merge, in seconds per second.
This is summed for all of the contributing threads.
merge-write-bytes-
The number of bytes written to disk for merges.
merge-write-time-
The time (as xs:dayTimeDuration) to write data for merges.
merge-write-rate-
The moving average of writing data for merges, in megabytes
per second.
merge-write-load-
The moving average of the load for writing for merges, in
seconds per second. This is summed for all of the threads
writing on the host.
backup-read-bytes-
The number of bytes read from disk for backups.
backup-read-time-
Thee time (as xs:dayTimeDuration) to read data for backups.
backup-read-rate-
The moving average of reading backup data from disk, in megabytes
per second.
backup-read-load-
The moving average of the read load on the backup, in seconds per
second. This is summed for all of the contributing threads.
backup-write-bytes-
The number of bytes written to disk for backups.
backup-write-time-
The time (as xs:dayTimeDuration) to write data to backups.
backup-write-rate-
The moving average of writing data for backups, in megabytes
per second.
backup-write-load-
The moving average of the load for writing for backups, in
seconds per second. This is summed for all of the threads
writing on the host.
restore-read-bytes-
The number of bytes read from disk for restores.
restore-read-time-
The time (as xs:dayTimeDuration) to read data for restores.
restore-read-rate-
The moving average of reading restore data from disk, in megabytes
per second.
restore-read-load-
The moving average of the read load on the backup, in seconds per
second. This is summed for all of the contributing threads.
restore-write-bytes-
The number of bytes written to disk for restores.
restore-write-time-
The time (as xs:dayTimeDuration) to write data for restores.
restore-write-rate-
The moving average of writing data for restores, in megabytes
per second.
restore-write-load-
The moving average of the load for writing for restores, in
seconds per second. This is summed for all of the threads
writing on the host.
large-read-bytes-
The number of bytes read from large documents.
large-read-time-
The time (as xs:dayTimeDuration) to read data from large documents.
large-read-rate-
The moving average of reading large documents from disk, in megabytes
per second.
large-read-load-
The moving average of the read load on large documents, in seconds per
second.
large-write-bytes-
The number of bytes written to disk for large documents.
large-write-time-
The time (as xs:dayTimeDuration) to write data for large documents.
large-write-rate-
The moving average of writing data for large documents, in megabytes
per second.
large-write-load-
The moving average of the load for writing for large documents, in
seconds per second.
database-replication-receive-bytes-
The number of bytes received for database replication.
database-replication-receive-time-
The time (as xs:dayTimeDuration) to receive data for database replication.
database-replication-receive-rate-
The moving average of receiving data for database replication, in megabytes
per second.
database-replication-receive-load-
The moving average of the load for receiving data for database replication, in
seconds per second.
database-replication-send-bytes-
The number of bytes sent for database replication.
database-replication-send-time-
The time (as xs:dayTimeDuration) to send data for database replication.
database-replication-send-rate-
The moving average of sending data for database replication, in megabytes
per second.
database-replication-send-load-
The moving average of the load for sending data for database replication, in
seconds per second.
read-lock-count-
The total number of read locks, summed across all forests on the host.
read-lock-wait-time-
The total time spent waiting for read locks, summed across all forests
on the host.
read-lock-hold-time-
The total time spent holding read locks, summed across all forests on
the host.
read-lock-rate-
The rate of taking read locks, summed across all forests on the host.
read-lock-wait-load-
The read lock wait load, summed across all forests on the host.
read-lock-hold-load-
The read lock hold load, summed across all forests on the host.
write-lock-count-
The total number of write locks, summed across all forests on the host.
write-lock-wait-time-
The total time spent waiting for write locks, summed across all forests
on the host.
write-lock-hold-time-
The total time spent holding write locks, summed across all forests on
the host.
write-lock-rate-
The rate of taking write locks, summed across all forests on the host.
write-lock-wait-load-
The write lock wait load, summed across all forests on the host.
write-lock-hold-load-
The write lock hold load, summed across all forests on the host.
deadlock-count-
The number of deadlocks, summed across all forests on the host.
deadlock-wait-time-
The total time spent waiting for locks that eventually deadlocked,
summed across all forests on the host.
deadlock-rate-
The rate of taking write locks, summed across all forests on the host.
deadlock-wait-load-
The deadlock wait load, summed across all forests on the host.
large-binary-cache-hits-
The number of hits on the large binary cache.
large-binary-cache-misses-
The number of misses on the large binary cache.
large-binary-cache-hit-rate-
The average number of hits on the large binary cache.
large-binary-cache-miss-rate-
The average number of misses on the large binary cache.
replicationThis is a complex element with the following element children:
foreign-master
-
Foreign master for this database.
This is a complex element with the following element children:
relation
- A specific related resource.
This is a complex element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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 resource related to the host.
foreign-database-id
-
A foreign database ID.
foreign-forest-id
-
A foreign forest ID.
foreign-replicas
-
Foreign replicas of this database.
This is a complex element with the following element children:
foreign-replica
-
Foreign replica of this database.
This is a complex element with the following element children:
relation
- A specific related resource.
This is a complex element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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 resource related to the host.
foreign-database-id
-
A foreign database ID.
foreign-forest-id
-
A foreign forest ID.
point-in-time-recovery-
Information about point in time recovery.
This is a complex element with the following element children:
journal-archive
-
Information about the journal archive.
This is a complex element with the following element children:
path
-
The path of the stand.
lag-limit
-
The lag limit.
pending-frames
-
The number of pending frames.
pending-bytes
-
The number of bytes for pending frames.
pending-lag
-
The time of the pending lag limit.
unclosed-stands-
The unclosed stands in the forest.
This is a complex element with the following element children:
unclosed-stand
-
The unclosed stand of a forest.
This is a complex element with the following element children:
stand-id
-
The unique key of a stand.
path
-
The path of the stand.
disk-size
-
The amount of space the stand takes on disk.
memory-size
-
The amount of space the stand takes in memory.
reference
-
The reference to an unclosed forest stand.
This is a complex element with the following element children:
count
-
The reference count.
earliest
-
The earliest refrence time.
latest
-
The latest refrence time.
frame
-
A stack frame.
forest-value-range-
Value range of a range index
This is a complex element with the following element children:
cts:base-reference
cts:range
fragment-count-
The total number of fragments for a given reindexing or rebalancing activity.
data-size-
The amount of space forest data files take up on disk.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/forests/my-forest-1&view=status
==> Returns status information on the forest named my-forest-1.
|
|
|
|
GET /manage/v2/forests/{id|name}/properties
|
|
 |
Summary:
Retrieve the current state of modifiable properties of the forest
identified by {id|name}.
|
Parameters:
format?
:
The format of the returned data. Can be html,
json, or xml (default). If present, the
format parameter overrides the Accept header.
|
|
Request Headers:
Accept*:
The expected MIME type of the response. If the format
parameter is present, it takes precedence over the Accept header.
Allowed values: application/xml,
application/json, and text/html.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK), and
the data in the response body contains the requested information.
|
Usage Notes:
The structure of the data
returned is as follows: A forest-properties element with the following element children:
enabled
-
Forest enabled status.
updates-allowed
-
The kinds of updates that should be allowed for this forest.
availability
-
Availability of the forest data.
rebalancer-enable
-
Enable automatic rebalancing after configuration changes.
range
-
Range configuration for the range assignment policy.
This is a complex element with the following element children: lower-bound-
The lower bound of the range on the forest.
upper-bound-
The upper bound of the range on the forest.
failover-enable
-
Enable assignment to a failover host if the primary host is down.
failover-hosts
- A list of hosts for shared disk failover.
This is a complex element with the following element children: failover-host- A host name or id for shared disk failover.
forest-replicas
- Replica forest definitions.
This is a complex element with the following element children: forest-replica- Replica forest definition.
This is a complex element with the following element children:
replica-name
- Name of the replica forest.
host
- A host name or id.
data-directory
-
The optional public directory for forests.
large-data-directory
-
The optional directory for large objects in a forest.
fast-data-directory
-
The optional smaller but faster directory for forests.
|
Example:
$ curl --anyauth --user user:password -X GET -i \
-H "Accept: application/xml" \
http://localhost:8002/manage/v2/forests/example/properties
==> Retrieve the state of the modifiable properties of the forest named
"example". MarkLogic Server responds with output similar to the following:
HTTP/1.1 200 OK
Content-type: application/xml
Cache-Control: no-cache
Expires: -1
Server: MarkLogic
Content-Length: 436
Connection: Keep-Alive
Keep-Alive: timeout=5
<forest-properties
xsi:schemaLocation="http://marklogic.com/manage manage.xsd"
xmlns="http://marklogic.com/manage"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<enabled>true</enabled>
<updates-allowed>all</updates-allowed>
<availability>online</availability>
<rebalancer-enable>true</rebalancer-enable>
<range/>
<failover-enable>true</failover-enable>
<failover-hosts/>
<forest-replicas/>
</forest-properties>
The corresponding JSON output is similar to the following:
{
"enabled": true,
"updates-allowed": "all",
"availability": "online",
"rebalancer-enable": true,
"range": null,
"failover-enable": true,
"failover-host": null,
"forest-replica": null
}
|
|
|
|
PUT /manage/v2/forests/{id|name}/properties
|
|
 |
Summary:
Modify the configuration of the forest identified by {id|name}.
|
Request Headers:
Content-type:
The MIME type of the data in the request body. Supported values:
application/xml, application/json.
|
|
Required Privilege:
This operation requires the manage-admin role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage-admin
|
Response:
Upon success, MarkLogic Server returns a status code 204 (No Content).
|
Usage Notes:
Properties included in the payload replace the existing configuration
of the same property, if any. All other properties remain unchanged.
Replacement applies even where multiple property values are supported,
such as replica forests. For example, if the request includes configuration
for forest-replicas, all previously existing replica
configuration is replaced. The operation is not additive. The structure
of the modifiable properties is as follows:
A forest-properties element with the following element children:
enabled
-
Forest enabled status.
updates-allowed
-
The kinds of updates that should be allowed for this forest.
availability
-
Availability of the forest data.
rebalancer-enable
-
Enable automatic rebalancing after configuration changes.
range
-
Range configuration for the range assignment policy.
This is a complex element with the following element children: lower-bound-
The lower bound of the range on the forest.
upper-bound-
The upper bound of the range on the forest.
failover-enable
-
Enable assignment to a failover host if the primary host is down.
failover-hosts
- A list of hosts for shared disk failover.
This is a complex element with the following element children: failover-host- A host name or id for shared disk failover.
forest-replicas
- Replica forest definitions.
This is a complex element with the following element children: forest-replica- Replica forest definition.
This is a complex element with the following element children:
replica-name
- Name of the replica forest.
host
- A host name or id.
data-directory
-
The optional public directory for forests.
large-data-directory
-
The optional directory for large objects in a forest.
fast-data-directory
-
The optional smaller but faster directory for forests.
|
Example:
$ cat ./forest-properties.xml
<forest-properties xmlns="http://marklogic.com/manage">
<enabled>false</enabled>
</forest-properties>
$ cat ./forest-properties.json
{ "enabled": true }
$ curl --anyauth --user user:password -X PUT -d @./forest-properties.xml \
-i -H "Content-type: application/xml" \
http://localhost:8002/manage/v2/forests/example-1/properties
==> The enabled property of the forest named example-1 is set to false.
All other properties are unchanged. MarkLogic Server responds with
output similar to the following:
HTTP/1.1 204 No Content
Server: MarkLogic
Content-Length: 0
Connection: Keep-Alive
Keep-Alive: timeout=5
|
|
|
|
|
 |
Summary:
This resource address returns a summary of the groups in the cluster.
|
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,
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
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:
A group-default-list element with the following element children:
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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-items
- Items of this resource type.
This is a complex element with the following element children: list-count- The number of items of this resource type.
list-item- An item of this resource type.
This is a complex element with the following element children:
uriref
- The path for 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.
item-summary
This is a complex element with the following element children:
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/groups
(: Returns a summary of the groups in the cluster. :)
|
|
|
|
GET /manage/v2/groups/{id|name}
|
|
 |
Summary:
This resource address returns information on the specified group.
The group can be identified either by id or name.
|
Parameters:
format
:
The format of the returned data. Can be either html,
json, or xml (default). This parameter is
not meaningful with view=edit. This value overrides the
Accept header if both are present.
|
view
:
A specific view of the returned data. Can be either config,
counts, edit, status, 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.
Allowed values: application/xml,
application/json, and text/html.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
For all views except edit, upon success, MarkLogic
Server returns status code 200 (OK), and the response body contains
the requested data. If view=edit, MarkLogic Server
responds with status code 302 (Found) and the Location header contains
a redirect to the appropriate page in the Admin Interface.
|
Usage Notes:
When view=counts, the count information includes the
document count, directory count, active fragment count, deleted
fragment count, and nascent fragment count.
The structure of the data in the response for the default view
is as follows:
A group-default element with the following element children:
id
-
A group unique id (64-bit value).
name
-
An internet email address.
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/groups/Default
==> Returns information on the Default group.
|
Example:
http://localhost:8002/manage/v2/groups/Default?view=status&format=JSON
==> Returns status information on the Default group.
|
Example:
http://localhost:8002/manage/v2/groups/Default?view=edit
==> Returns a redirect to the Admin Interface page for the Default group.
|
|
|
|
GET /manage/v2/groups/{id|name}?view=config
|
|
 |
Summary:
This resource address returns configuration information on the
specified group. The group can be identified either by id or name.
|
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.
|
|
Request Headers:
Accept*:
The expected MIME type of the response. If the format
parameter is present, it takes precedence over the Accept header.
Allowed values: application/xml,
application/json, and text/html.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK), and the
response body contains the requested data.
|
Usage Notes:
The structure of the data
returned is as follows: A group-config element with the following element children:
id
-
A group unique id (64-bit value).
name
-
An internet email address.
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element children:
error-type
- The kind of error.
error-name
- The name of the error.
error-code
- The error identifier.
error-message
- The error text.
config-properties
- The configuration properties of the group.
This is a complex element with the following element children: list-cache-size-
list-cache-partitions-
compressed-tree-cache-size-
compressed-tree-cache-partitions-
compressed-tree-read-size-
An integer amount for block sizes in kilobytes, min 8, max 16384.
expanded-tree-cache-size-
expanded-tree-cache-partitions-
triple-cache-size-
triple-cache-partitions-
triple-value-cache-size-
triple-value-cache-partitions-
triple-cache-timeout-
The number of seconds of inactivity before triple index pages are
eligable to be flushed from the cache.
triple-value-cache-timeout-
The number of seconds of inactivity before triple value index pages are
eligable to be flushed from the cache.
email-address-
The email address of the system administrator.
smtp-relay-
The name of the SMTP mail relay host.
smtp-timeout-
The SMTP response timeout, in seconds.
http-user-agent-
The HTTP User-agent string used
when making HTTP requests.
http-timeout-
The HTTP response timeout, in seconds.
xdqp-timeout-
The XDQP protocol timeout, in seconds.
host-timeout-
The host response timeout, in seconds.
host-initial-timeout-
The host initial response timeout, in seconds.
retry-timeout-
The request retry timeout, in seconds.
module-cache-timeout-
Flush from caches modules unused after this many seconds.
system-log-level-
The minimum log level for log messages sent to the operating system.
file-log-level-
The minimum log level for log messages in the log file.
rotate-log-files-
When to start a new log file.
keep-log-files-
How many log files to keep.
failover-enable-
Enable forest assignment to a failover host
when the primary host is down.
xdqp-ssl-enabled-
Whether or not SSL is enabled for XDQP.
xdqp-ssl-allow-sslv3-
Whether or not SSLv3 is allowed for XDQP.
xdqp-ssl-allow-tls-
Whether or not TLS is allowed for XDQP.
xdqp-ssl-ciphers-
A colon separated list of ciphers (e.g. ALL:!LOW:@STRENGTH)
schemas-
The schema binding specifications.
This is a complex element with the following element children:
schema
-
A schema binding specification.
This is a complex element with the following element children:
namespace-uri
-
A namespace URI.
schema-location
-
A schema location.
namespaces-
The namespace binding specifications.
This is a complex element with the following element children:
namespace
-
A namespace binding specification.
This is a complex element with the following element children:
prefix
-
A QName prefix.
namespace-uri
-
A namespace URI.
using-namespace
-
A namespace path URI.
This is a complex element with the following element children:
namespace-uri
-
A namespace URI.
module-locations-
The module location specifications.
This is a complex element with the following element children:
module-location
-
A module location specification.
This is a complex element with the following element children:
namespace-uri
-
A namespace URI.
location
-
A module location.
events-activated-
Activates the trace event mechanism.
events-
The list of events to enable.
This is a complex element with the following element children:
event
-
The event specification.
This is a complex element with the following element children:
event-id
-
The string identifier of the event.
level
-
The level of verbosity for the event output.
count
-
The optional number of times to execute the event.
skip
-
The number of events to skip when executing an event.
audit-
Audit specification.
This is a complex element with the following element children:
audit-enabled
-
Enables auditing.
rotate-audit-files
-
When to start a new audit log file.
keep-audit-files
-
How many audit files to keep.
audit-events
-
The list of audit events to enable.
This is a complex element with the following element children:
audit-event
-
The audit event specification.
This is a complex element with the following element children:
audit-event-name
-
The string identifier of the audit event.
audit-event-enabled
-
Enables a specified audit event.
audit-restrictions
-
The list of audit restrictions.
This is a complex element with the following element children:
audit-restriction
-
The audit restriction specification.
This is a complex element with the following element children:
audit-restriction-name
-
The string identifier of the audit restriction.
audit-restriction-type
-
The string identifier of the audit restriction.
audit-restriction-items
-
The string identifier of the audit restriction.
background-io-limit-
The maximum I/O rate allowable for background operations
(merge, backup, restore).
metering-enabled-
Enable Usage metering.
performance-metering-enabled-
Enable performance monitoring history.
meters-database-
The metering and performance history database.
performance-metering-period-
Historic performance metering period (seconds).
performance-metering-retain-raw-
Retain raw performance metering data in days.
performance-metering-retain-hourly-
Retain hourly performance metering data in days.
performance-metering-retain-daily-
Retain daily performance metering data in days.
s3-domain-
The simple storage service internet domain name.
s3-protocol-
The simple storage service network protocol.
s3-server-side-encryption-
Specifies server side encryption for data at rest
on the simple storage service.
security-database-
The security database where global security data are kept for hosts in this group.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/groups/Default?view=config
==> Returns configuration information on the Default group.
|
|
|
|
GET /manage/v2/groups/{id|name}?view=counts
|
|
 |
Summary:
This resource address returns counts information on the specified group.
The group can be identified either by id or name.
|
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.
|
|
Request Headers:
Accept*:
The expected MIME type of the response. If the format
parameter is present, it takes precedence over the Accept header.
Allowed values: application/xml,
application/json, and text/html.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK), and the
response body contains the requested data.
|
Usage Notes:
The count information includes the document count, directory count,
active fragment count, deleted fragment count, and nascent fragment count.
The structure of the data
returned is as follows: A group-counts element with the following element children:
id
-
A group unique id (64-bit value).
name
-
An internet email address.
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element children:
error-type
- The kind of error.
error-name
- The name of the error.
error-code
- The error identifier.
error-message
- The error text.
count-properties
- The statistics about the group.
This is a complex element with the following element children: document-count- The number of documents in forests on hosts in the group.
directory-count- The number of directories in forests on hosts in the group.
active-fragments- The number of fragments in active use in forests on hosts in the group.
deleted-fragments- The number of fragments marked for deletion in forests on hosts in the group.
nascent-fragments- The number of nascent fragments in forests on hosts in the group.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/groups/Default?view=counts
==> Returns counts information on the Default group.
|
|
|
|
GET /manage/v2/groups/{id|name}?view=status
|
|
 |
Summary:
This resource address returns status information on the
specified group. The group can be identified either by id or name.
|
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.
|
|
Request Headers:
Accept*:
The expected MIME type of the response. If the format
parameter is present, it takes precedence over the Accept header.
Allowed values: application/xml,
application/json, and text/html.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK), and the
response body contains the requested data.
|
Usage Notes:
The structure of the data
returned is as follows: A group-status element with the following element children:
id
-
A group unique id (64-bit value).
name
-
An internet email address.
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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-properties
- The summary of operating characteristics of hosts in the group.
This is a complex element with the following element children: hosts-status-summaryThis is a complex element with the following element children:
total-hosts
- The total number of hosts.
load-properties
- The summary of load properties of hosts in the group.
This is a complex element with the following element children:
total-load
- The sum of the processing load factors
in seconds per second.
load-detail
- The detailed load characteristics for hosts in the group.
This is a complex element with the following element children:
query-read-load
-
The moving average of the read load on the query, in seconds per second.
This is summed for all of the contributing threads.
journal-write-load
-
The moving average of the load for writing to the journal, in
seconds per second. This is summed for all of the threads
writing on the host.
save-write-load
-
The moving average of the load for writing to in-memory stands, in
seconds per second. This is summed for all of the threads
writing on the host.
merge-read-load
-
The moving average of the read load on the merge, in seconds per second.
This is summed for all of the contributing threads.
merge-write-load
-
The moving average of the load for writing for merges, in
seconds per second. This is summed for all of the threads
writing on the host.
backup-read-load
-
The moving average of the read load on the backup, in seconds per
second. This is summed for all of the contributing threads.
backup-write-load
-
The moving average of the load for writing for backups, in
seconds per second. This is summed for all of the threads
writing on the host.
restore-read-load
-
The moving average of the read load on the backup, in seconds per
second. This is summed for all of the contributing threads.
restore-write-load
-
The moving average of the load for writing for restores, in
seconds per second. This is summed for all of the threads
writing on the host.
large-read-load
-
The moving average of the read load on large documents, in seconds per
second.
large-write-load
-
The moving average of the load for writing for large documents, in
seconds per second.
external-binary-read-load
-
The moving average of the read load on external binary documents, in seconds per
second.
xdqp-client-receive-load
-
The moving average of the receive load for the xdqp client, in
seconds per second. This is summed for all of the contributing threads.
xdqp-client-send-load
-
The moving average of the send load for the xdqp client, in
seconds per second. This is summed for all of the contributing threads.
xdqp-server-receive-load
-
The moving average of the receive load for the xdqp server, in
seconds per second. This is summed for all of the contributing threads.
xdqp-server-send-load
-
The moving average of the send load for the xdqp server, in
seconds per second. This is summed for all of the contributing threads.
foreign-xdqp-client-receive-load
-
The moving average of the receive load for the xdqp client, in
seconds per second. This is summed for all of the contributing threads.
foreign-xdqp-client-send-load
-
The moving average of the send load for the xdqp client, in
seconds per second. This is summed for all of the contributing threads.
foreign-xdqp-server-receive-load
-
The moving average of the receive load for the xdqp server, in
seconds per second. This is summed for all of the contributing threads.
foreign-xdqp-server-send-load
-
The moving average of the send load for the xdqp server, in
seconds per second. This is summed for all of the contributing threads.
read-lock-wait-load
-
The read lock wait load, summed across all forests on the host.
read-lock-hold-load
-
The read lock hold load, summed across all forests on the host.
write-lock-wait-load
-
The write lock wait load, summed across all forests on the host.
write-lock-hold-load
-
The write lock hold load, summed across all forests on the host.
deadlock-wait-load
-
The deadlock wait load, summed across all forests on the host.
rate-properties
- The summary of rate properties of the hosts in the group.
This is a complex element with the following element children:
total-rate
- The sum of the processing rate factors
in seconds per second.
rate-detail
- The detailed rate characteristics for the hosts in the group.
This is a complex element with the following element children:
memory-process-swap-rate
-
The swap rate for the MarkLogic process in pages/sec.
memory-system-pagein-rate
-
The page in rate for the system in pages/sec.
memory-system-pageout-rate
-
The page out rate for the system in pages/sec.
memory-system-swapin-rate
-
The swap in rate for the system in pages/sec.
memory-system-swapout-rate
-
The swap out rate for the system in pages/sec.
query-read-rate
-
The moving average of reading query data from disk, in megabytes
per second.
journal-write-rate
-
The moving average of writing data to the journal, in megabytes
per second.
save-write-rate
-
The moving average of writing data to in-memory stands, in megabytes
per second.
merge-read-rate
-
The moving average of reading merge data from disk, in megabytes
per second.
merge-write-rate
-
The moving average of writing data for merges, in megabytes
per second.
backup-read-rate
-
The moving average of reading backup data from disk, in megabytes
per second.
backup-write-rate
-
The moving average of writing data for backups, in megabytes
per second.
restore-read-rate
-
The moving average of reading restore data from disk, in megabytes
per second.
restore-write-rate
-
The moving average of writing data for restores, in megabytes
per second.
large-read-rate
-
The moving average of reading large documents from disk, in megabytes
per second.
large-write-rate
-
The moving average of writing data for large documents, in megabytes
per second.
external-binary-read-rate
-
The moving average of reading external binary documents from disk, in megabytes
per second.
xdqp-client-receive-rate
-
The moving average of receiving xdqp client messages, in megabytes
per second.
xdqp-client-send-rate
-
The moving average of sending xdqp client messages, in megabytes
per second.
xdqp-server-receive-rate
-
The moving average of receiving xdqp server messages, in megabytes
per second.
xdqp-server-send-rate
-
The moving average of sending xdqp server messages, in megabytes
per second.
foreign-xdqp-client-receive-rate
-
The moving average of receiving xdqp client messages, in megabytes
per second.
foreign-xdqp-client-send-rate
-
The moving average of sending xdqp client messages, in megabytes
per second.
foreign-xdqp-server-receive-rate
-
The moving average of receiving xdqp server messages, in megabytes
per second.
foreign-xdqp-server-send-rate
-
The moving average of sending xdqp server messages, in megabytes
per second.
read-lock-rate
-
The rate of taking read locks, summed across all forests on the host.
write-lock-rate
-
The rate of taking write locks, summed across all forests on the host.
deadlock-rate
-
The rate of taking write locks, summed across all forests on the host.
servers-status-summary- The status summary for servers in the group.
This is a complex element with the following element 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 the servers of the group.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/groups/Default?view=status
==> Returns status information on the Default group.
|
|
|
|
|
 |
Summary:
Retrieve information about the hosts in a cluster. The data returned
depends on the view parameter setting.
|
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 hosts in the specified group. The group can
be identified either by id or name.
|
view
:
A specific view of the returned data. Can be either
schema, status, metrics,
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK), and
the response body contains the requested information.
|
Usage Notes:
The structure of the data in the response for the default view
is as follows:
A host-default-list element with the following element children:
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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-items
- Items of this resource type.
This is a complex element with the following element children: list-count- The number of items of this resource type.
list-item- An item of this resource type.
This is a complex element with the following element children:
uriref
- The path for 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.
item-summary
This is a complex element with the following element children:
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/hosts
(: Returns a summary of the hosts in the cluster. :)
|
Example:
http://localhost:8002/manage/v2/hosts?view=status
(: Returns a status summary of the hosts in the cluster. :)
|
|
|
|
GET /manage/v2/hosts?view=status
|
|
 |
Summary:
Retrieve status information about the hosts in the cluster.
|
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
:
Restrict results to the hosts in the specified group. The group can
be identified either by id or name.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK), and
the response body contains the requested information.
|
Usage Notes:
The structure of the data
returned is as follows: A host-status-list element with the following element children:
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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
- Status summary for the hosts in the list.
This is a complex element with the following element children: total-hosts- The total number of hosts.
load-properties- The load properties of the host.
This is a complex element with the following element children:
total-load
- The sum of the processing load factors
in seconds per second.
load-detail
- The detailed load characteristics for the host.
This is a complex element with the following element children:
query-read-load
-
The moving average of the read load on the query, in seconds per second.
This is summed for all of the contributing threads.
journal-write-load
-
The moving average of the load for writing to the journal, in
seconds per second. This is summed for all of the threads
writing on the host.
save-write-load
-
The moving average of the load for writing to in-memory stands, in
seconds per second. This is summed for all of the threads
writing on the host.
merge-read-load
-
The moving average of the read load on the merge, in seconds per second.
This is summed for all of the contributing threads.
merge-write-load
-
The moving average of the load for writing for merges, in
seconds per second. This is summed for all of the threads
writing on the host.
backup-read-load
-
The moving average of the read load on the backup, in seconds per
second. This is summed for all of the contributing threads.
backup-write-load
-
The moving average of the load for writing for backups, in
seconds per second. This is summed for all of the threads
writing on the host.
restore-read-load
-
The moving average of the read load on the backup, in seconds per
second. This is summed for all of the contributing threads.
restore-write-load
-
The moving average of the load for writing for restores, in
seconds per second. This is summed for all of the threads
writing on the host.
large-read-load
-
The moving average of the read load on large documents, in seconds per
second.
large-write-load
-
The moving average of the load for writing for large documents, in
seconds per second.
external-binary-read-load
-
The moving average of the read load on external binary documents, in seconds per
second.
xdqp-client-receive-load
-
The moving average of the receive load for the xdqp client, in
seconds per second. This is summed for all of the contributing threads.
xdqp-client-send-load
-
The moving average of the send load for the xdqp client, in
seconds per second. This is summed for all of the contributing threads.
xdqp-server-receive-load
-
The moving average of the receive load for the xdqp server, in
seconds per second. This is summed for all of the contributing threads.
xdqp-server-send-load
-
The moving average of the send load for the xdqp server, in
seconds per second. This is summed for all of the contributing threads.
foreign-xdqp-client-receive-load
-
The moving average of the receive load for the xdqp client, in
seconds per second. This is summed for all of the contributing threads.
foreign-xdqp-client-send-load
-
The moving average of the send load for the xdqp client, in
seconds per second. This is summed for all of the contributing threads.
foreign-xdqp-server-receive-load
-
The moving average of the receive load for the xdqp server, in
seconds per second. This is summed for all of the contributing threads.
foreign-xdqp-server-send-load
-
The moving average of the send load for the xdqp server, in
seconds per second. This is summed for all of the contributing threads.
read-lock-wait-load
-
The read lock wait load, summed across all forests on the host.
read-lock-hold-load
-
The read lock hold load, summed across all forests on the host.
write-lock-wait-load
-
The write lock wait load, summed across all forests on the host.
write-lock-hold-load
-
The write lock hold load, summed across all forests on the host.
deadlock-wait-load
-
The deadlock wait load, summed across all forests on the host.
rate-properties- The rate properties of the host.
This is a complex element with the following element children:
total-rate
- The sum of the processing rate factors
in seconds per second.
rate-detail
- The detailed rate characteristics for the host.
This is a complex element with the following element children:
memory-process-swap-rate
-
The swap rate for the MarkLogic process in pages/sec.
memory-system-pagein-rate
-
The page in rate for the system in pages/sec.
memory-system-pageout-rate
-
The page out rate for the system in pages/sec.
memory-system-swapin-rate
-
The swap in rate for the system in pages/sec.
memory-system-swapout-rate
-
The swap out rate for the system in pages/sec.
query-read-rate
-
The moving average of reading query data from disk, in megabytes
per second.
journal-write-rate
-
The moving average of writing data to the journal, in megabytes
per second.
save-write-rate
-
The moving average of writing data to in-memory stands, in megabytes
per second.
merge-read-rate
-
The moving average of reading merge data from disk, in megabytes
per second.
merge-write-rate
-
The moving average of writing data for merges, in megabytes
per second.
backup-read-rate
-
The moving average of reading backup data from disk, in megabytes
per second.
backup-write-rate
-
The moving average of writing data for backups, in megabytes
per second.
restore-read-rate
-
The moving average of reading restore data from disk, in megabytes
per second.
restore-write-rate
-
The moving average of writing data for restores, in megabytes
per second.
large-read-rate
-
The moving average of reading large documents from disk, in megabytes
per second.
large-write-rate
-
The moving average of writing data for large documents, in megabytes
per second.
external-binary-read-rate
-
The moving average of reading external binary documents from disk, in megabytes
per second.
xdqp-client-receive-rate
-
The moving average of receiving xdqp client messages, in megabytes
per second.
xdqp-client-send-rate
-
The moving average of sending xdqp client messages, in megabytes
per second.
xdqp-server-receive-rate
-
The moving average of receiving xdqp server messages, in megabytes
per second.
xdqp-server-send-rate
-
The moving average of sending xdqp server messages, in megabytes
per second.
foreign-xdqp-client-receive-rate
-
The moving average of receiving xdqp client messages, in megabytes
per second.
foreign-xdqp-client-send-rate
-
The moving average of sending xdqp client messages, in megabytes
per second.
foreign-xdqp-server-receive-rate
-
The moving average of receiving xdqp server messages, in megabytes
per second.
foreign-xdqp-server-send-rate
-
The moving average of sending xdqp server messages, in megabytes
per second.
read-lock-rate
-
The rate of taking read locks, summed across all forests on the host.
write-lock-rate
-
The rate of taking write locks, summed across all forests on the host.
deadlock-rate
-
The rate of taking write locks, summed across all forests on the host.
status-list-items
- The hosts reflected in the status summary.
This is a complex element with the following element children: status-list-item- A host reflected in the status summary.
This is a complex element with the following element children:
uriref
- The path for a resource or list of resources.
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 element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/hosts?view=status
(: Returns a status summary of the hosts in the cluster. :)
|
|
|
|
GET /manage/v2/hosts/{id|name}
|
|
 |
Summary:
This resource address returns information on a specific host. The host can
be identified either by id or name.
|
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 config,
counts, edit, status,
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
For all views except edit, upon success, MarkLogic
Server returns status code 200 (OK), and the response body contains
the requested data. If view=edit, MarkLogic Server
responds with status code 302 (Found) and the Location header contains
a redirect to the appropriate page in the Admin Interface.
|
Usage Notes:
When view=counts, the count information includes the
document count, directory count, active fragment count, deleted
fragment count, and nascent fragment count.
The structure of the data in the response for the default view
is as follows:
A host-default element with the following element children:
id
-
A host unique id (64-bit value).
name
-
The name of the Host
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/hosts/myhost
==> Returns information on the 'myhost' host.
|
Example:
http://localhost:8002/manage/v2/hosts/myhost?view=config&format=json
==> Returns configuration information on the 'myhost' host, as JSON.
|
Example:
http://localhost:8002/manage/v2/hosts/myhost?view=edit
==> Returns a redirect to the Admin Interface configuration page
for the 'myhost' host.
|
|
|
|
POST /manage/v2/hosts/{id|name}
|
|
 |
Summary:
Initiate a state change on a host, such as a shutdown or restart.
|
Parameters:
state
:
The type of state change to initiate. Allowed values:
shutdown, restart. This parameter must be
specified as form data in the POST body.
|
format?
:
The format of the returned data. Can be either json,
or xml (default). This value overrides the Accept
header if both are present.
|
|
Request Headers:
Accept*:
The expected MIME type of the response. If the format
parameter is present, it takes precedence over the Accept header.
Supported values: application/xml,
application/json.
|
Content-type:
The MIME type of the data in the request body. The only supported
value is application/x-www-form-urlencoded.
|
|
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.
|
Location?:
If the requested operation causes a restart, a reference to
the timestamp service is returned in the Location header. Use
this reference to test for successful completion of the restart.
|
|
Required Privilege:
This operation requires the manage-admin role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage-admin
|
Response:
MarkLogic Server returns status code 202 (Accepted). The response
body includes the last start time. If the operation is asynchronous,
a reference to the timestamp service is included in the Location
header and the response data. Use it to confirm successful completion.
|
Usage Notes:
Restart is an asynchronous operation. You can use the timestamp
reference returned in the Location header and the response body to
test for successful completion of the restart. For details, see
GET /admin/v1/timestamp.
|
Example:
$ curl --anyauth --user password:password -X POST -i --data "state=restart" \
-H "Content-type: application/x-www-form-urlencoded" \
http://localhost:8002/manage/v2/hosts/my-host
==> MarkLogic Server is restarted on the host my-host. MarkLogic Server
returns output similar to the following. Use the timestamp reference
in the Location header or the response body to check on the status.
HTTP/1.1 202 Accepted
Content-type: application/xml
Cache-Control: no-cache
Expires: -1
Location: /admin/v1/timestamp
Server: MarkLogic
Content-Length: 291
Connection: Keep-Alive
Keep-Alive: timeout=5
<restart xmlns="http://marklogic.com/manage">
<last-startup host-id="13544732455686476949">
2013-09-21T09:55:40.929792-07:00
</last-startup>
<link>
<kindref>timestamp</kindref>
<uriref>/admin/v1/timestamp</uriref>
</link>
<message>Check for new timestamp to verify host restart.</message>
</restart>
The following is the equivalent JSON response data:
{ "restart": {
"last-startup": {
"host-id":"13544732455686476949",
"value":"2013-09-23T09:16:32.897234-07:00"
},
"link":{
"kindref":"timestamp",
"uriref":"\/admin\/v1\/timestamp"
},
"message":"Check for new timestamp to verify host restart."
}}
|
Example:
$ curl --anyauth --user user:password -X POST -i --data "state=shutdown" \
-H "Content-type: application/x-www-form-urlencoded" \
http://localhost:8002/manage/v2/hosts/my-host?format=JSON
==> MarkLogic Server is shut down on the host my-host. MarkLogic Server
returns output similar to the following.
HTTP/1.1 202 Accepted
Content-type: application/json
Cache-Control: no-cache
Expires: -1
Server: MarkLogic
Content-Length: 148
Connection: Keep-Alive
Keep-Alive: timeout=5
{ "shutdown": {
"last-startup":"2013-09-23T09:10:22.375938-07:00",
"message":"Shutdown of host my-host (13544732455686476949) initiated."
}}
|
|
|
|
GET /manage/v2/hosts/{id|name}?view=config
|
|
 |
Summary:
This resource address returns configuration information on a specific host.
The host can be identified either by id or name.
|
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.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK), and
the response body contains the requested data.
|
Usage Notes:
The structure of the data
returned is as follows: A host-config element with the following element children:
id
-
A host unique id (64-bit value).
name
-
The name of the Host
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element children:
error-type
- The kind of error.
error-name
- The name of the error.
error-code
- The error identifier.
error-message
- The error text.
config-properties
- The configuration characteristics of the host.
This is a complex element with the following element children: bind-port-
The distributed protocol server socket bind internet port number.
connect-port-
The distributed protocol client socket connect internet port number.
foreign-bind-port-
The distributed protocol server socket bind internet port number.
foreign-connect-port-
The distributed protocol client socket connect internet port number.
zone-
Zone the host belongs to.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/hosts/myhost?view=config&format=json
==> Returns configuration information on the 'myhost' host, as JSON.
|
|
|
|
GET /manage/v2/hosts/{id|name}?view=counts
|
|
 |
Summary:
This resource address returns counts information on a specific host.
The host can be identified either by id or name.
|
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.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK), and
the response body contains the requested data.
|
Usage Notes:
The count information includes the document count, directory count,
active fragment count, deleted fragment count, and nascent fragment
count.
The structure of the data
returned is as follows: A host-counts element with the following element children:
id
-
A host unique id (64-bit value).
name
-
The name of the Host
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element children:
error-type
- The kind of error.
error-name
- The name of the error.
error-code
- The error identifier.
error-message
- The error text.
count-properties
- The statistics about the host.
This is a complex element with the following element children: document-count- The number of documents in forests on the host.
directory-count- The number of directories in forests on the host.
active-fragments- The number of fragments in active use in forests on the host.
deleted-fragments- The number of fragments marked for deletion in forests on the host.
nascent-fragments- The number of nascent fragments in forests on the host.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/hosts/myhost?view=counts
==> Returns counts information on the 'myhost' host.
|
|
|
|
GET /manage/v2/hosts/{id|name}?view=status
|
|
 |
Summary:
This resource address returns status information on a specific host.
The host can be identified either by id or name.
|
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.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK), and
the response body contains the requested data.
|
Usage Notes:
The structure of the data
returned is as follows: A host-status element with the following element children:
id
-
A host unique id (64-bit value).
name
-
The name of the Host
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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-properties
- Operating characteristics of the host.
This is a complex element with the following element children: online-
Is this host seen as online? (true for online)
error-
The error in processing forest status.
secure-
Is communication secured with SSL? For the local host, this is always
false.
load-properties- The load properties of the host.
This is a complex element with the following element children:
total-load
- The sum of the processing load factors
in seconds per second.
load-detail
- The detailed load characteristics for the host.
This is a complex element with the following element children:
query-read-load
-
The moving average of the read load on the query, in seconds per second.
This is summed for all of the contributing threads.
journal-write-load
-
The moving average of the load for writing to the journal, in
seconds per second. This is summed for all of the threads
writing on the host.
save-write-load
-
The moving average of the load for writing to in-memory stands, in
seconds per second. This is summed for all of the threads
writing on the host.
merge-read-load
-
The moving average of the read load on the merge, in seconds per second.
This is summed for all of the contributing threads.
merge-write-load
-
The moving average of the load for writing for merges, in
seconds per second. This is summed for all of the threads
writing on the host.
backup-read-load
-
The moving average of the read load on the backup, in seconds per
second. This is summed for all of the contributing threads.
backup-write-load
-
The moving average of the load for writing for backups, in
seconds per second. This is summed for all of the threads
writing on the host.
restore-read-load
-
The moving average of the read load on the backup, in seconds per
second. This is summed for all of the contributing threads.
restore-write-load
-
The moving average of the load for writing for restores, in
seconds per second. This is summed for all of the threads
writing on the host.
large-read-load
-
The moving average of the read load on large documents, in seconds per
second.
large-write-load
-
The moving average of the load for writing for large documents, in
seconds per second.
external-binary-read-load
-
The moving average of the read load on external binary documents, in seconds per
second.
xdqp-client-receive-load
-
The moving average of the receive load for the xdqp client, in
seconds per second. This is summed for all of the contributing threads.
xdqp-client-send-load
-
The moving average of the send load for the xdqp client, in
seconds per second. This is summed for all of the contributing threads.
xdqp-server-receive-load
-
The moving average of the receive load for the xdqp server, in
seconds per second. This is summed for all of the contributing threads.
xdqp-server-send-load
-
The moving average of the send load for the xdqp server, in
seconds per second. This is summed for all of the contributing threads.
foreign-xdqp-client-receive-load
-
The moving average of the receive load for the xdqp client, in
seconds per second. This is summed for all of the contributing threads.
foreign-xdqp-client-send-load
-
The moving average of the send load for the xdqp client, in
seconds per second. This is summed for all of the contributing threads.
foreign-xdqp-server-receive-load
-
The moving average of the receive load for the xdqp server, in
seconds per second. This is summed for all of the contributing threads.
foreign-xdqp-server-send-load
-
The moving average of the send load for the xdqp server, in
seconds per second. This is summed for all of the contributing threads.
read-lock-wait-load
-
The read lock wait load, summed across all forests on the host.
read-lock-hold-load
-
The read lock hold load, summed across all forests on the host.
write-lock-wait-load
-
The write lock wait load, summed across all forests on the host.
write-lock-hold-load
-
The write lock hold load, summed across all forests on the host.
deadlock-wait-load
-
The deadlock wait load, summed across all forests on the host.
rate-properties- The rate properties of the host.
This is a complex element with the following element children:
total-rate
- The sum of the processing rate factors
in seconds per second.
rate-detail
- The detailed rate characteristics for the host.
This is a complex element with the following element children:
memory-process-swap-rate
-
The swap rate for the MarkLogic process in pages/sec.
memory-system-pagein-rate
-
The page in rate for the system in pages/sec.
memory-system-pageout-rate
-
The page out rate for the system in pages/sec.
memory-system-swapin-rate
-
The swap in rate for the system in pages/sec.
memory-system-swapout-rate
-
The swap out rate for the system in pages/sec.
query-read-rate
-
The moving average of reading query data from disk, in megabytes
per second.
journal-write-rate
-
The moving average of writing data to the journal, in megabytes
per second.
save-write-rate
-
The moving average of writing data to in-memory stands, in megabytes
per second.
merge-read-rate
-
The moving average of reading merge data from disk, in megabytes
per second.
merge-write-rate
-
The moving average of writing data for merges, in megabytes
per second.
backup-read-rate
-
The moving average of reading backup data from disk, in megabytes
per second.
backup-write-rate
-
The moving average of writing data for backups, in megabytes
per second.
restore-read-rate
-
The moving average of reading restore data from disk, in megabytes
per second.
restore-write-rate
-
The moving average of writing data for restores, in megabytes
per second.
large-read-rate
-
The moving average of reading large documents from disk, in megabytes
per second.
large-write-rate
-
The moving average of writing data for large documents, in megabytes
per second.
external-binary-read-rate
-
The moving average of reading external binary documents from disk, in megabytes
per second.
xdqp-client-receive-rate
-
The moving average of receiving xdqp client messages, in megabytes
per second.
xdqp-client-send-rate
-
The moving average of sending xdqp client messages, in megabytes
per second.
xdqp-server-receive-rate
-
The moving average of receiving xdqp server messages, in megabytes
per second.
xdqp-server-send-rate
-
The moving average of sending xdqp server messages, in megabytes
per second.
foreign-xdqp-client-receive-rate
-
The moving average of receiving xdqp client messages, in megabytes
per second.
foreign-xdqp-client-send-rate
-
The moving average of sending xdqp client messages, in megabytes
per second.
foreign-xdqp-server-receive-rate
-
The moving average of receiving xdqp server messages, in megabytes
per second.
foreign-xdqp-server-send-rate
-
The moving average of sending xdqp server messages, in megabytes
per second.
read-lock-rate
-
The rate of taking read locks, summed across all forests on the host.
write-lock-rate
-
The rate of taking write locks, summed across all forests on the host.
deadlock-rate
-
The rate of taking write locks, summed across all forests on the host.
status-detail- The detailed status characteristics for the host.
This is a complex element with the following element children:
error
-
The error in processing forest status.
zone
-
Zone the host belongs to.
bind-port
-
The distributed protocol server socket bind internet port number.
connect-port
-
The distributed protocol client socket connect internet port number.
ssl-fips-enabled
-
Is ssl fips mode enabled for this host?
foreign-bind-port
-
The distributed protocol server socket bind internet port number.
foreign-connect-port
-
The distributed protocol client socket connect internet port number.
background-io-limit
-
A rate limit for background I/O (MB/s, 0 means no limit).
metering-enabled
-
Metering Enabled
meters-database
-
The ID of the Meters database.
performance-metering-enabled
-
Monitoring Enabled
performance-metering-period
-
Monitor period in seconds
performance-metering-retain-raw
-
Retain raw monitoring data in days
performance-metering-retain-hourly
-
Retain hourly monitoring data in days
performance-metering-retain-daily
-
Retain daily monitoring data in days
last-startup
-
The timestamp of last host startup
version
-
The version of the product.
architecture
-
The achitecture of the product.
platform
-
The platform of the product.
license-key
-
The license key for this host.
licensee
-
The host licensee.
license-key-expires
-
When does the license key for this host expire.
license-key-cpus
-
How many cpus does this license key support.
license-key-cores
-
How many cores does this license key support.
license-key-size
-
The database size (in MB) that this license key support.
license-key-options
-
The options that this host's license key provides.
This is a complex element with the following element children:
license-key-option
-
A license key option.
pre-release-expires
-
When does the pre-release for this host expire.
accepted-version
-
The last accepted version.
accepted-agreement
-
The last accepted agreement.
accepted-licensee
-
The last accepted licensee.
edition
-
The edition of this host.
environment
-
The environment of this host.
cpus
-
The number of CPUs.
cores
-
The number of cores.
core-threads
-
The number of core threads (including intel hyper threads).
total-cpu-stat-user
-
Total cpu utilization for user.
total-cpu-stat-nice
-
Total cpu utilization for nice.
total-cpu-stat-system
-
Total cpu utilization for system.
total-cpu-stat-idle
-
Total cpu utilization for idle.
total-cpu-stat-iowait
-
Total cpu utilization for iowait.
total-cpu-stat-irq
-
Total cpu utilization for irq.
total-cpu-stat-softirq
-
Total cpu utilization for softirq.
total-cpu-stat-steal
-
Total cpu utilization for steal.
total-cpu-stat-guest
-
Total cpu utilization for guest.
total-cpu-stat-guest-nice
-
Total cpu utilization for guest nice.
cpu-stat-user
-
Total cpu utilization for user.
cpu-stat-nice
-
Total cpu utilization for nice.
cpu-stat-system
-
Total cpu utilization for system.
cpu-stat-idle
-
Total cpu utilization for idle.
cpu-stat-iowait
-
Total cpu utilization for iowait.
cpu-stat-irq
-
Total cpu utilization for irq.
cpu-stat-softirq
-
Total cpu utilization for softirq.
cpu-stat-steal
-
Total cpu utilization for steal.
cpu-stat-guest
-
Total cpu utilization for guest.
cpu-stat-guest-nice
-
Total cpu utilization for guest nice.
memory-process-size
-
The number of MB of total process virtual memory for the MarkLogic process.
memory-process-rss
-
The number of MB of Process Resident Size (RSS) for the MarkLogic process.
memory-process-anon
-
The number of MB of Process Anonymous Memory for the MarkLogic process.
memory-process-rss-hwm
-
The mazimum (High Water Mark) of Process Resident Size (RSS) in MB for the MarkLogic process.
memory-process-swap-rate
-
The swap rate for the MarkLogic process in pages/sec.
memory-process-swap-size
-
The number of MB of memory swapped out for the MarkLogic process.
memory-system-pagein-rate
-
The page in rate for the system in pages/sec.
memory-system-pageout-rate
-
The page out rate for the system in pages/sec.
memory-system-swapin-rate
-
The swap in rate for the system in pages/sec.
memory-system-swapout-rate
-
The swap out rate for the system in pages/sec.
memory-size
-
The amount of space the stand takes in memory.
host-size
-
The total data size of all forests on the host. The size is
calculated by adding the fast data directory size and the
data directory size for each forest on this host, but
it does not include any content stored in the large data
directory.
host-large-data-size
-
The total size of all large binary data on the host.
log-device-space
-
The number of MB left on log device.
data-dir-space
-
The number of MB left on data dir.
backup-jobs
-
The backup jobs the host is processing.
This is a complex element with the following element children:
backup-job
-
The backup job.
This is a complex element with the following element children:
job-id
-
The unique ID of a job.
path
-
The path of the stand.
start-time
-
The time a merge started.
forests
-
The forests in a backup/restore job
This is a complex element with the following element children:
forest
-
A forest with id and status
This is a complex element with the following element children:
forest-id
-
The unique key of the forest.
status
restore-jobs
-
The restore jobs the host is processing.
This is a complex element with the following element children:
restore-job
-
The restore job.
This is a complex element with the following element children:
job-id
-
The unique ID of a job.
path
-
The path of the stand.
start-time
-
The time a merge started.
safe-restore-to-time
-
The safest timestamp closest to the restore-to-time at which the forest
is in a consistent state.
forests
-
The forests in a backup/restore job
This is a complex element with the following element children:
forest
-
A forest with id and status
This is a complex element with the following element children:
forest-id
-
The unique key of the forest.
status
native-plugins
- The native plugins loaded on a host.
This is a complex element with the following element children:
native-plugin
- The status of a native plugin.
This is a complex element with the following element children:
path
-
The path of the stand.
version
-
The version of the product.
capabilities
- The capabilities of a native plugin.
This is a complex element with the following element children:
aggregate
- The name of an aggregate native plugin capability
query-read-bytes
-
The number of bytes read off disk.
query-read-time
-
The time (as xs:dayTimeDuration) to read query data from disk.
query-read-rate
-
The moving average of reading query data from disk, in megabytes
per second.
query-read-load
-
The moving average of the read load on the query, in seconds per second.
This is summed for all of the contributing threads.
journal-write-bytes
-
The number of bytes written to the journal on disk.
journal-write-time
-
The time (as xs:dayTimeDuration) to write data to the journal.
journal-write-rate
-
The moving average of writing data to the journal, in megabytes
per second.
journal-write-load
-
The moving average of the load for writing to the journal, in
seconds per second. This is summed for all of the threads
writing on the host.
save-write-bytes
-
The number of bytes written when saving in-memory stands.
save-write-time
-
The time (as xs:dayTimeDuration) spent saving in-memory stands.
save-write-rate
-
The moving average of writing data to in-memory stands, in megabytes
per second.
save-write-load
-
The moving average of the load for writing to in-memory stands, in
seconds per second. This is summed for all of the threads
writing on the host.
merge-read-bytes
-
The number of bytes read during merges.
merge-read-time
-
The time (as xs:dayTimeDuration) to read data for merges.
merge-read-rate
-
The moving average of reading merge data from disk, in megabytes
per second.
merge-read-load
-
The moving average of the read load on the merge, in seconds per second.
This is summed for all of the contributing threads.
merge-write-bytes
-
The number of bytes written to disk for merges.
merge-write-time
-
The time (as xs:dayTimeDuration) to write data for merges.
merge-write-rate
-
The moving average of writing data for merges, in megabytes
per second.
merge-write-load
-
The moving average of the load for writing for merges, in
seconds per second. This is summed for all of the threads
writing on the host.
backup-read-bytes
-
The number of bytes read from disk for backups.
backup-read-time
-
Thee time (as xs:dayTimeDuration) to read data for backups.
backup-read-rate
-
The moving average of reading backup data from disk, in megabytes
per second.
backup-read-load
-
The moving average of the read load on the backup, in seconds per
second. This is summed for all of the contributing threads.
backup-write-bytes
-
The number of bytes written to disk for backups.
backup-write-time
-
The time (as xs:dayTimeDuration) to write data to backups.
backup-write-rate
-
The moving average of writing data for backups, in megabytes
per second.
backup-write-load
-
The moving average of the load for writing for backups, in
seconds per second. This is summed for all of the threads
writing on the host.
restore-read-bytes
-
The number of bytes read from disk for restores.
restore-read-time
-
The time (as xs:dayTimeDuration) to read data for restores.
restore-read-rate
-
The moving average of reading restore data from disk, in megabytes
per second.
restore-read-load
-
The moving average of the read load on the backup, in seconds per
second. This is summed for all of the contributing threads.
restore-write-bytes
-
The number of bytes written to disk for restores.
restore-write-time
-
The time (as xs:dayTimeDuration) to write data for restores.
restore-write-rate
-
The moving average of writing data for restores, in megabytes
per second.
restore-write-load
-
The moving average of the load for writing for restores, in
seconds per second. This is summed for all of the threads
writing on the host.
large-read-bytes
-
The number of bytes read from large documents.
large-read-time
-
The time (as xs:dayTimeDuration) to read data from large documents.
large-read-rate
-
The moving average of reading large documents from disk, in megabytes
per second.
large-read-load
-
The moving average of the read load on large documents, in seconds per
second.
large-write-bytes
-
The number of bytes written to disk for large documents.
large-write-time
-
The time (as xs:dayTimeDuration) to write data for large documents.
large-write-rate
-
The moving average of writing data for large documents, in megabytes
per second.
large-write-load
-
The moving average of the load for writing for large documents, in
seconds per second.
external-binary-read-bytes
-
The number of bytes read from external binary documents.
external-binary-read-time
-
Thee time (as xs:dayTimeDuration) to read data from external binary documents.
external-binary-read-rate
-
The moving average of reading external binary documents from disk, in megabytes
per second.
external-binary-read-load
-
The moving average of the read load on external binary documents, in seconds per
second.
xdqp-client-receive-bytes
-
The number of bytes received by the xdqp client for host
communications.
xdqp-client-receive-time
-
The time (as xs:dayTimeDuration) to receive xdqp client
communication.
xdqp-client-receive-rate
-
The moving average of receiving xdqp client messages, in megabytes
per second.
xdqp-client-receive-load
-
The moving average of the receive load for the xdqp client, in
seconds per second. This is summed for all of the contributing threads.
xdqp-client-send-bytes
-
The number of bytes sent by the xdqp client for host
communications.
xdqp-client-send-time
-
The time (as xs:dayTimeDuration) to send xdqp client
communication.
xdqp-client-send-rate
-
The moving average of sending xdqp client messages, in megabytes
per second.
xdqp-client-send-load
-
The moving average of the send load for the xdqp client, in
seconds per second. This is summed for all of the contributing threads.
xdqp-server-receive-bytes
-
The number of bytes received by the xdqp server for host
communications.
xdqp-server-receive-time
-
The time (as xs:dayTimeDuration) to receive xdqp server
communication.
xdqp-server-receive-rate
-
The moving average of receiving xdqp server messages, in megabytes
per second.
xdqp-server-receive-load
-
The moving average of the receive load for the xdqp server, in
seconds per second. This is summed for all of the contributing threads.
xdqp-server-send-bytes
-
The number of bytes sent by the xdqp server for host
communications.
xdqp-server-send-time
-
The time (as xs:dayTimeDuration) to send xdqp server
communication.
xdqp-server-send-rate
-
The moving average of sending xdqp server messages, in megabytes
per second.
xdqp-server-send-load
-
The moving average of the send load for the xdqp server, in
seconds per second. This is summed for all of the contributing threads.
foreign-xdqp-client-receive-bytes
-
The number of bytes received by the xdqp client for host
communications.
foreign-xdqp-client-receive-time
-
The time (as xs:dayTimeDuration) to receive xdqp client
communication.
foreign-xdqp-client-receive-rate
-
The moving average of receiving xdqp client messages, in megabytes
per second.
foreign-xdqp-client-receive-load
-
The moving average of the receive load for the xdqp client, in
seconds per second. This is summed for all of the contributing threads.
foreign-xdqp-client-send-bytes
-
The number of bytes sent by the xdqp client for host
communications.
foreign-xdqp-client-send-time
-
The time (as xs:dayTimeDuration) to send xdqp client
communication.
foreign-xdqp-client-send-rate
-
The moving average of sending xdqp client messages, in megabytes
per second.
foreign-xdqp-client-send-load
-
The moving average of the send load for the xdqp client, in
seconds per second. This is summed for all of the contributing threads.
foreign-xdqp-server-receive-bytes
-
The number of bytes received by the xdqp server for host
communications.
foreign-xdqp-server-receive-time
-
The time (as xs:dayTimeDuration) to receive xdqp server
communication.
foreign-xdqp-server-receive-rate
-
The moving average of receiving xdqp server messages, in megabytes
per second.
foreign-xdqp-server-receive-load
-
The moving average of the receive load for the xdqp server, in
seconds per second. This is summed for all of the contributing threads.
foreign-xdqp-server-send-bytes
-
The number of bytes sent by the xdqp server for host
communications.
foreign-xdqp-server-send-time
-
The time (as xs:dayTimeDuration) to send xdqp server
communication.
foreign-xdqp-server-send-rate
-
The moving average of sending xdqp server messages, in megabytes
per second.
foreign-xdqp-server-send-load
-
The moving average of the send load for the xdqp server, in
seconds per second. This is summed for all of the contributing threads.
read-lock-count
-
The total number of read locks, summed across all forests on the host.
read-lock-wait-time
-
The total time spent waiting for read locks, summed across all forests
on the host.
read-lock-hold-time
-
The total time spent holding read locks, summed across all forests on
the host.
read-lock-rate
-
The rate of taking read locks, summed across all forests on the host.
read-lock-wait-load
-
The read lock wait load, summed across all forests on the host.
read-lock-hold-load
-
The read lock hold load, summed across all forests on the host.
write-lock-count
-
The total number of write locks, summed across all forests on the host.
write-lock-wait-time
-
The total time spent waiting for write locks, summed across all forests
on the host.
write-lock-hold-time
-
The total time spent holding write locks, summed across all forests on
the host.
write-lock-rate
-
The rate of taking write locks, summed across all forests on the host.
write-lock-wait-load
-
The write lock wait load, summed across all forests on the host.
write-lock-hold-load
-
The write lock hold load, summed across all forests on the host.
deadlock-count
-
The number of deadlocks, summed across all forests on the host.
deadlock-wait-time
-
The total time spent waiting for locks that eventually deadlocked,
summed across all forests on the host.
deadlock-rate
-
The rate of taking write locks, summed across all forests on the host.
deadlock-wait-load
-
The deadlock wait load, summed across all forests on the host.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/hosts/myhost?view=status
==> Returns status information on the 'myhost' host.
|
|
|
|
GET /manage/v2/hosts/{id|name}/properties
|
|
 |
Summary:
This resource address returns the current state of modifiable properties
of the specified host.
|
Parameters:
format
:
The format of the returned data. Can be either html,
json, or xml (default). If present, the
format parameter overrides the Accept header.
|
|
Request Headers:
Accept*:
The expected MIME type of the response. If the format
parameter is present, it takes precedence over the Accept header.
Allowed values: application/xml,
application/json, and text/html.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK), and
the response body contains the requested information.
|
Usage Notes:
The structure of the data
returned is as follows: A host-properties element with the following element children:
host-name
-
The internet host name.
group
- A group name or id.
bind-port
-
The distributed protocol server socket bind internet port number.
foreign-bind-port
-
The distributed protocol foreign server socket bind internet port number.
zone
-
Zone the host belongs to.
|
Example:
$ curl --anyauth --user user:password -X GET -i \
http://localhost:8002/manage/v2/hosts/my-host/properties
HTTP/1.1 200 OK
Content-type: application/xml
Cache-Control: no-cache
Expires: -1
Server: MarkLogic
Content-Length: 356
Connection: Keep-Alive
Keep-Alive: timeout=5
<host-properties
xsi:schemaLocation="http://marklogic.com/manage manage.xsd"
xmlns="http://marklogic.com/manage"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<host-name>my-host</host-name>
<group>16709278353323551294</group>
<bind-port>7999</bind-port>
<foreign-bind-port>7998</foreign-bind-port>
<zone/>
</host-properties>
The equivalent JSON output is shown below:
{
"host-name": "my-host",
"group": "16709278353323551294",
"bind-port": 7999,
"foreign-bind-port": 7998,
"zone":""
}
|
|
|
|
PUT /manage/v2/hosts/{id|name}/properties
|
|
 |
Summary:
Initiate a properties change on the specified host.
|
Parameters:
format
:
The format of the data in the request body. Can be json
or xml. If present, the format
parameter overrides the request Content-type header.
|
|
Request Headers:
Accept*:
The expected MIME type of the response. If the format
parameter is present, it takes precedence over the Accept header.
Supported values: application/xml,
application/json.
|
Content-type:
The MIME type of the data in the request body, either
application/xml or application/json.
|
|
Response Headers:
Content-type*:
The MIME type of the data in the response body. Use the Accept header
or format request parameter to specify a preferred format.
The format parameter takes precedence over the Accept
header if both are present.
|
Location?:
If the requested operation causes a restart, a reference to
the timestamp service is returned in the Location header. Use
this reference to test for successful completion of the restart.
|
|
Required Privilege:
This operation requires the manage-admin role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage-admin
|
Response:
Upon success, MarkLogic Server returns a status code 202 (Accepted) if
the request causes a restart, or status code 204 (No Content)
if the request does not cause a restart. In the event of a restart,
the response body includes the timestamp of the last restart and a link
to the timestamp endpoint.
|
Usage Notes:
The data in the request body can contain one or more properties to
modify. Properties that are not included are unchanged. Use
GET /manage/v2/hosts/{id|name}/properties to see what properties
can be modified.
Some property changes cause a restart. If a restart occurs, the
response includes a reference to the timestamp service in the
Location header and the response body. Use this information to
confirm successful completion of the restart. For details, see
GET /admin/v1/timestamp.
The data in the request body has the following structure:
A host-properties element with the following element children:
host-name
-
The internet host name.
group
- A group name or id.
bind-port
-
The distributed protocol server socket bind internet port number.
foreign-bind-port
-
The distributed protocol foreign server socket bind internet port number.
zone
-
Zone the host belongs to.
|
Example:
$ cat host-prop.xml
<host-properties xmlns="http://marklogic.com/manage">
<zone>my-new-zone</zone>
</host-properties>
$ curl --anyauth --user user:password -X PUT -d @./host-prop.xml \
-i -H "Content-type: application/xml" \
http://localhost:8002/manage/v2/hosts/my-host/properties
==> The zone property of host my-host is modified. MarkLogic Server
returns headers similar to the following:
HTTP/1.1 204 No Content
Server: MarkLogic
Content-Length: 0
Connection: Keep-Alive
Keep-Alive: timeout=5
|
Example:
$ cat host-prop.json
{ "zone":"my-new-zone" }
$ curl --anyauth --user user:password -X PUT -d @./host-prop.json \
-i -H "Content-type: application/json" \
http://localhost:8002/manage/v2/hosts/my-host/properties
==> The zone property of host my-host is modified. MarkLogic Server
returns headers similar to the following:
HTTP/1.1 204 No Content
Server: MarkLogic
Content-Length: 0
Connection: Keep-Alive
Keep-Alive: timeout=5
|
|
|
|
GET /manage/v2/meters/labels
|
|
 |
Summary:
This resource address returns all of the labels stored for the monitoring history
timespans. All labels are returned, unless the start,
end, or name parameters specify otherwise.
|
Parameters:
format
:
The format of the returned data. Can be either
json (default) or xml. This value overrides
the Accept header if both are present.
|
name
:
Return only the label that match this name. The name can include wildcards, so
more than one label can be returned.
|
start
:
Return the labels with timespans that fall on or after this timestamp
(in the form of dateTime).
|
end
:
Return the labels with timespans that fall on or before this timestamp
(in the form of dateTime).
|
|
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, either
application/xml or application/json.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK). The
response body contains the requested data.
|
Example:
http://localhost:8002/manage/v2/meters/labels
==> Returns all of the monitoring history labels.
|
|
|
|
OPTIONS /manage/v2/meters/labels
|
|
 |
Summary:
This resource address returns information on the
/manage/v2/meters/labels endpoint.
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK)
and the information on the labels endpoint.
|
Example:
curl -X OPTIONS --digest -u admin:password \
"http://localhost:8002/manage/v2/meters/labels"
==>
<rest:request xmlns:rest="http://marklogic.com/appservices/rest">
<rest:http method="GET HEAD OPTIONS">
<rest:param name="start" as="dateTime" required="true" default="1970-01-01T00:00:00"/>
<rest:param name="end" as="dateTime" required="true" default="2013-10-10T10:18:08"/>
<rest:param name="name" as="string" default="*"/>
</rest:http>
<rest:http method="POST">
<rest:content-type>application/json</rest:content-type>
<rest:content-type>application/xml</rest:content-type>
</rest:http>
<rest:param name="format" as="string" values="xml|json|html"/>
<rest:or>
<rest:accept>application/xml</rest:accept>
<rest:accept>application/json</rest:accept>
<rest:accept>text/html</rest:accept>
</rest:or>
</rest:request>
|
|
|
|
POST /manage/v2/meters/labels
|
|
 |
Summary:
This resource address creates a label and returns the ID of the created label.
The label name must be unique.
The event element in the payload body
must be either marker or duration.
|
Parameters:
format
:
The format of the posted data. Can be either
json (default) or xml. This value overrides
the Accept header if both are present.
|
|
Request Headers:
Accept:
The expected MIME type of the response. If the format
parameter is present, it takes precedence over the Accept header.
|
Content-type:
The MIME type of the data in the request body, either
application/xml or application/json.
|
|
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, either
application/xml or application/json.
|
|
Required Privilege:
This operation requires the manage-admin role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK)
and the ID of the created label.
|
Example:
cat label.xml
==>
<label xmlns="http://marklogic.com/manage/meters/label">
<name>new label</name>
<event>marker</event>
<start_dt>2013-10-08T00:00:00</start_dt>
<end_dt>2013-10-09T00:00:00</end_dt>
<text>label text</text>
<meta><info>more information</info></meta>
</label>
curl -i -X POST --digest -u admin:password \
-H "Content-type: application/xml" -d @label.xml \
"http://localhost:8002/manage/v2/meters/labels"
==> Posts the label to MarkLogic Server and returns the
generated id.
|
|
|
|
DELETE /manage/v2/meters/labels/{id|name}
|
|
 |
Summary:
This resource address deletes the named label.
|
Required Privilege:
This operation requires the manage-admin role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK).
|
Example:
curl -X DELETE --digest -u admin:password \
"http://localhost:8002/manage/v2/meters/labels/3108808182876923314"
==> Deletes the 3108808182876923314 label from MarkLogic Server.
|
|
|
|
HEAD /manage/v2/meters/labels/{id|name}
|
|
 |
Summary:
This resource address tests to see if the named label is in MarkLogic Server.
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
200 OK is returned if the named
label exists. Otherwise 404 Not Found is returned.
|
Example:
curl -i -X HEAD --digest -u admin:password \
"http://localhost:8002/manage/v2/meters/labels/3108808182876923314"
==> Checks for the existance of the 3108808182876923314 label.
|
|
|
|
OPTIONS /manage/v2/meters/labels/{id|name}
|
|
 |
Summary:
This resource address returns information on the
/manage/v2/meters/labels/{id|name} endpoint.
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK)
and the information on the labels endpoint.
|
Example:
curl -X OPTIONS --digest -u admin:password \
"http://localhost:8002/manage/v2/meters/labels/3108808182876923314"
==>
<rest:request xmlns:rest="http://marklogic.com/appservices/rest">
<rest:uri-param name="version">$1</rest:uri-param>
<rest:uri-param required="false" name="label-id">$2</rest:uri-param>
<rest:http method="GET HEAD OPTIONS">
<rest:param name="start" as="dateTime" required="true" default="1970-01-01T00:00:00"/>
<rest:param name="end" as="dateTime" required="true" default="2013-10-10T13:34:58"/>
<rest:param name="name" as="string" default="*"/>
</rest:http>
<rest:http method="PUT">
<rest:content-type>application/json</rest:content-type>
<rest:content-type>application/xml</rest:content-type>
</rest:http>
<rest:http method="DELETE"/>
<rest:param name="format" as="string" values="xml|json|html"/>
<rest:or>
<rest:accept>application/xml</rest:accept>
<rest:accept>application/json</rest:accept>
<rest:accept>text/html</rest:accept>
</rest:or>
</rest:request>
|
|
|
|
GET /manage/v2/meters/resources
|
|
 |
Summary:
This resource address returns a list of all of the resources in the local cluster
that existed in specified time period..
Note that using the start and end parameters
to define a time range may be expensive.
|
Parameters:
format
:
The format of the returned data. Can be either
json (default) or xml. This value overrides
the Accept header if both are present.
|
period
:
The frequency of the returned data. A value of raw returns the resources
just as they were captured with the set frequency. A value of hour returns
the resources
once per hour (this is the default). A value of day returns the resources once per day.
|
start
:
Return the resource list, starting at this timestamp (in the form of dateTime).
|
end
:
Return the resource list, ending at this timestamp (in the form of dateTime).
|
|
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, either
application/xml or application/json.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
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 body is as follows:
The structure of the data
returned is as follows: A meter-status element with the following element children:
|
Example:
http://localhost:8002/manage/v2/meters/resources
==> Returns the list resources in the cluster.
|
|
|
|
|
 |
Summary:
This resource address returns a summary of the requests in the cluster.
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK). The
response body contains the requested data.
|
Usage Notes:
The structure of the data
returned is as follows: A request-default-list element with the following element children:
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: list-count- The number of requests in the list.
list-item- A request reflected in the summary.
This is a complex element with the following element children:
relation
- A specific related resource.
This is a complex element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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 element with the following element 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.
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 element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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. :)
|
|
|
|
GET /manage/v2/requests/{id|uri}
|
|
 |
Summary:
This resource address returns information on the specified request. The request can
be identified either by id or URI.
|
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 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 information to the request in the specified
host. The host can be identified either by id or name.
|
server-id
:
Specifies to limit the information to the request in the specified
server. The server can be identified either by id or name.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK). The
response body contains the requested data.
|
Usage Notes:
The structure of the data
returned is as follows: A request-default element with the following element children:
id
- An id for a request
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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.
properties
- Characteristics of the request.
This is a complex element with the following element 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.
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 element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/12741641870611184141
(: Returns information on the request with the id, 12741641870611184141. :)
|
|
|
|
|
 |
Summary:
This resource address returns data about the App Servers in the
cluster. The data returned depends on the setting of the view
request parameter. The default view provides a summary of the servers.
|
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. If not specified, the response
includes information about all App Servers.
|
view
:
A specific view of the returned data. Can be either
schema, status, metrics,
package, or default.
|
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. This parameter is not
meaningful with view=package.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK). The
response body contains the requested data.
|
Usage Notes:
Use view=package to retrieve configuration details about
App Servers in a format suitable for use with the
/manage/v2/packages interfaces. You can request a package
view as HTML, XML, or JSON, but only the XML and JSON formats can be
used as input to the /manage/v2/packages interfaces, such as
POST /manage/v2/packages/{pkgname}.
The structure of the data in the response body for the default view
is shown below. For details on other views, see the API reference
for each view variant.
A server-default-list element with the following element children:
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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-items
This is a complex element with the following element children: list-count- The number of servers in the list.
list-item- A server in the list.
This is a complex element with the following element children:
relation
- A specific related resource.
This is a complex element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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 element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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?group-id=Default
==> Returns summary information for App Servers in the Default group.
|
Example:
http://localhost:8002/manage/v2/servers?view=package
==> Returns the package data for the all App Servers in the cluster.
|
|
|
|
GET /manage/v2/servers?view=metrics
|
|
 |
Summary:
Retrieve historical monitoring data about the App Servers in the cluster.
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK). The
response body contains the requested data.
|
Example:
http://localhost:8002/manage/v2/servers?view=metrics
(: Returns historical monitoring data for the servers in the cluster. :)
|
|
|
|
GET /manage/v2/servers?view=status
|
|
 |
Summary:
This resource address returns status information for the App Servers in the
cluster.
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK). The
response body contains the requested data.
|
Usage Notes:
The structure of the data
returned is as follows: A server-status-list element with the following element children:
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: status-list-item- A server reflected in the status summary.
This is a complex element with the following element children:
relation
- A specific related resource.
This is a complex element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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 element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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. :)
|
|
|
|
GET /manage/v2/servers/{id|name}
|
|
 |
Summary:
This resource address returns data about a specific App Server.
The server can be identified either by id or name. The data returned depends
on the value of the view request parameter. The default
view is a summary with links to additional data.
|
Parameters:
group-id
:
The id or name of the group to which the App Server belongs. This
parameter is required.
|
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 config,
edit, status, package, or
default.
|
host-id
:
Meaningful only when view=status. Specifies to return the
status for the server in the specified host. The host can be identified
either by id or name.
|
fullrefs
:
Meaningful only with view=status. 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.
|
modules?
:
Meaningful only with view=package.
Whether or not to include a manifest of the modules database for the
App Server in the results, if one exists. It is an error to request
a modules database manifest for an App Server that uses the filesystem
for modules. Default: false.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
For all views except edit, upon success, MarkLogic
Server returns status code 200 (OK), and the response body contains
the requested data. If view=edit, MarkLogic Server
responds with status code 302 (Found) and the Location header contains
a redirect to the appropriate configuration page in the Admin Interface.
|
Usage Notes:
The structure of the data in the response for the default view
is as follows:
A server-default element with the following element children:
id
-
An HTTP server id.
name
-
An HTTP server name.
server-kind
- The kind of server, which is either
http, task, webDAV, xdbc, or odbc.
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/Admin?group-id=Default
(: Returns information on the Admin server in the Default group. :)
|
Example:
http://localhost:8002/manage/v2/servers/Admin?group-id=Default&view=status
(: Returns the status of the Admin server in the Default group. :)
|
|
|
|
GET /manage/v2/servers/{id|name}?view=config
|
|
 |
Summary:
This resource address returns configuration data about a specific App Server.
The server can be identified either by id or name.
|
Parameters:
group-id
:
The id or name of the group to which the App Server belongs. This
parameter is required.
|
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.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK), and the
data in the response body contains the requested data.
|
Usage Notes:
The data in the response body varies, depending on the App Server
type (HTTP, XDBC, ODBC, etc.). The structure of the data in the
resopnse for an HTTP App Server is as follows:
A http-server-config element with the following element children:
id
-
An HTTP server id.
name
-
An HTTP server name.
server-kind
- The kind of server, which is either
http, task, webDAV, xdbc, or odbc.
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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.
http-config-properties
- The configuration properties of the HTTP server.
This is a complex element with the following element children: enabled-
Appserver enabled status.
root-
The root document directory pathname.
The module directory root.
The module directory root.
port-
The server socket bind internet port number.
webDAV-
webDAV server versus HTTP server.
execute-
True if server executes xquery modules.
display-last-login-
Indicates whether an appserver should display users' last login
information.
address-
The server socket bind numeric internet address.
backlog-
The socket listen backlog.
threads-
The maximum number of server threads allowed.
request-timeout-
The request socket recv timeout, in seconds.
keep-alive-timeout-
The keep-alive socket recv timeout, in seconds.
session-timeout-
The session expiration timeout, in seconds.
max-time-limit-
The upper bound for a request's time limit, in seconds.
default-time-limit-
The default time limit for a request, in seconds.
static-expires-
Add an "expires" HTTP header for static content to expire after this many seconds.
pre-commit-trigger-depth-
The maximum depth of pre-commit trigger invocation.
pre-commit-trigger-limit-
The maximum number of triggers a single statement can invoke.
collation-
The default collation for queries.
authentication-
The authentication scheme to use for this server
internal-security-
Whether or not the security database is used for authentication and authorization.
external-security-
External authentication and authorization configuration.
default-user-
The user used as the default user in application level
authentication. Using the admin user as the default user is
equivalent to turning security off.
privilege-
The privilege restricting access to the server.
concurrent-request-limit-
The maximum number of concurrent requests per user.
compute-content-length-
Compute content lengths for webDAV.
log-errors-
Log uncaught request processing errors to ErrorLog.txt.
debug-allow-
Allow debugging on this server.
profile-allow-
Allow profiling on this server.
default-xquery-version-
The default XQuery language version for this server.
multi-version-concurrency-control-
Specifies concurrency control of read-only queries.
distribute-timestamps-
Specifies the distribution of commit timestamps after updates.
output-sgml-character-entities-
Output SGML character entities.
output-encoding-
The default output encoding.
output-method-
Output method.
output-byte-order-mark-
The output sequence of octets is to be preceded by a Byte Order Mark.
output-cdata-section-namespace-uri-
Namespace URI of the "cdata section localname" specified below.
output-cdata-section-localname-
Element localname or list of element localnames to be output as CDATA sections.
output-doctype-public-
A public identifier to use on the emitted DOCTYPE.
output-doctype-system-
A system identifier to use on the emitted DOCTYPE.
output-escape-uri-attributes-
Apply Unicode normalization, percent-encoding, and HTML escaping to serialized URI attributes.
output-include-content-type-
Include the content-type declaration when serializing the node.
output-indent-
Pretty-print typed XML (that is, XML for which there is an
in-scope schema).
output-indent-untyped-
Pretty-print untyped XML (that is, XML for which there is no
in-scope schema).
output-media-type-
A mimetype representing a media type.
output-normalization-form-
A Unicode normalization to be applied to serialized output.
output-omit-xml-declaration-
Omit the XML declaration in serialized output.
output-standalone-
For a value of "yes" or "no", include "standalone=<value>" in the XML declaration; for a value of "omit", omit "standalone=".
output-undeclare-prefixes-
Undeclare the namespace prefix of any child element that does not bind the prefix of its parent element.
output-version-
Optionally stipulate conformance to a specific version of the output method.
output-include-default-attributes-
Specifies whether attributes defaulted with a schema should be
included in the serialization.
error-handler-
The script that handles 400 and 500 errors for this server.
schemas-
The schema binding specifications.
This is a complex element with the following element children:
schema
-
A schema binding specification.
This is a complex element with the following element children:
namespace-uri
-
A namespace URI.
schema-location
-
A schema location.
namespaces-
The namespace binding specifications.
This is a complex element with the following element children:
namespace
-
A namespace binding specification.
This is a complex element with the following element children:
prefix
-
A QName prefix.
namespace-uri
-
A namespace URI.
using-namespace
-
A namespace path URI.
This is a complex element with the following element children:
namespace-uri
-
A namespace URI.
module-locations-
The module location specifications.
This is a complex element with the following element children:
module-location
-
A module location specification.
This is a complex element with the following element children:
namespace-uri
-
A namespace URI.
location
-
A module location.
request-blackouts-
Users, roles, or periods during which requests will
be denied.
This is a complex element with the following element children:
request-blackout
-
A request blackout specification.
This is a complex element with the following element children:
users
-
The users that this blackout is active for.
roles
-
The roles that this blackout is active for.
blackout-type
-
What type of blackout is this.
days
-
The days that this blackout is active.
This is a complex element with the following element children:
day
-
A day that this blackout is active.
period
-
A period, which is all day, a start time and a duration, or a
start and end time.
This is a complex element with the following element children:
start-date
-
The starting date (in MM/DD/YYYY notation)
start-time
-
The starting time (in 24:00 notation).
end-date
-
The ending date (in MM/DD/YYYY notation)
end-time
-
The ending time (in 24:00 notation).
duration
-
The duration, specifed as hours:minutes (i.e. 2 hours 5 minutes is 2:05)
url-rewriter-
The script that rewrites URLs for this server.
rewrite-resolves-globally-
Allow rewritten URLs to be resolved from the global MarkLogic Modules/ directory.
ssl-certificate-template-
The certificate template. When
a certificate template is specified, the App Server uses an SSL
encrypted protocol (e.g. https, davs, xccs). The certificate
template specifies the common information for the individual SSL
certificates needed for each host in the group. You can add a new
certificate template by navigating to
Security > Certificate Templates > Create
ssl-allow-sslv3-
Whether or not SSLv3 is allowed.
ssl-allow-tls-
Whether or not TLS is allowed.
ssl-hostname-
The host name for the server's SSL certificate. This is
useful when many servers are running behind a load balancer. If not
specified, each host will use a certificate specifying its own hostname.
Note that per RFC 2459, hostnames must not exceed 64 characters in length.
ssl-ciphers-
A colon separated list of ciphers (e.g. ALL:!LOW:@STRENGTH)
ssl-require-client-certificate-
Whether or not a client certificate is required. This only has an
effect when one or more more client certificate authorities are
specified, in which case a value of true will refuse a client request
if it does not present a valid client certificate.
ssl-client-certificate-authorities-
Certificate authorities that may sign client certificates for this
server. Selecting one or more certificate authorities when SSL is
enabled will require all clients to present a valid certificate signed
by one of the selected authorities. Clicking on an organization below
will reveal the certificate authorities for that organization.
This is a complex element with the following element children:
ssl-client-certificate-authority
-
An SSL certificate authority
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/Admin?group-id=Default
==> Returns configuration information for the Admin App Server
in the Default group.
|
|
|
|
GET /manage/v2/servers/{id|name}?view=package
|
|
 |
Summary:
This resource address returns configuration details about the named
App Server in a format suitable for use with the
/manage/v2/packages interfaces. The server can be identifed
either by id or name.
|
Parameters:
group-id
:
The id or name of the group to which the App Server belongs. This
parameter is required.
|
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.
|
modules?
:
Whether or not to include a manifest of the modules database for the
App Server in the results, if one exists. It is an error to request
a modules database manifest for an App Server that uses the filesystem
for modules. Default: false.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK), and the
response body contains the requested data.
|
Usage Notes:
You can request a package view as HTML, XML, or JSON, but only the
XML and JSON formats can be used as input to the
/manage/v2/packages interfaces, such as
POST /manage/v2/packages/{pkgname}. The structure of
the data in the response body depends on the type of App Server
(HTTP, XDBC, ODBC, etc.).
|
Example:
http://localhost:8002/manage/v2/servers/MyServer?group-id=Default&view=package
==> Returns the package representation of the App Server MyServer
in the Default group.
|
|
|
|
GET /manage/v2/servers/{id|name}?view=status
|
|
 |
Summary:
This resource address returns status information about a specific App Server.
The server can be identified either by id or name.
|
Parameters:
group-id
:
The id or name of the group to which the App Server belongs. This
parameter is required.
|
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.
|
host-id
:
Return status for this App Server on the specified host. The host 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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK), and the
response body contains the requested data.
|
Usage Notes:
The structure of the data
returned is as follows: A server-status element with the following element children:
id
-
An HTTP server id.
name
-
An HTTP server name.
server-kind
- The kind of server, which is either
http, task, webDAV, xdbc, or odbc.
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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-properties
- The operating characteristics of the server.
This is a complex element with the following element children: enabled-
Appserver enabled status.
port-
The server socket bind internet port number.
root-
The root document directory pathname.
The module directory root.
The module directory root.
display-last-login-
Indicates whether an appserver should display users' last login
information.
backlog-
The socket listen backlog.
threads-
The maximum number of server threads allowed.
max-threads- The maximum number of server threads allowed.
request-timeout-
The request socket recv timeout, in seconds.
keep-alive-timeout-
The keep-alive socket recv timeout, in seconds.
session-timeout-
The session expiration timeout, in seconds.
static-expires-
Add an "expires" HTTP header for static content to expire after this many seconds.
max-time-limit-
The upper bound for a request's time limit, in seconds.
default-time-limit-
The default time limit for a request, in seconds.
multi-version-concurrency-control-
Specifies concurrency control of read-only queries.
authentication-
The authentication scheme to use for this server
default-user-
The user used as the default user in application level
authentication. Using the admin user as the default user is
equivalent to turning security off.
privilege-
The privilege restricting access to the server.
concurrent-request-limit-
The maximum number of concurrent requests per user.
default-xquery-version-
The default XQuery language version for this server.
output-sgml-character-entities-
Output SGML character entities.
output-encoding-
The default output encoding.
error-handler-
The script that handles 400 and 500 errors for this server.
url-rewriter-
The script that rewrites URLs for this server.
total-request-rate- The rounded sum of the request rate
in requests per second.
total-expanded-tree-cache-miss-rate- The rounded sum of the average number
of misses on the expanded cache.
total-expanded-tree-cache-hit-rate- The rounded sum of the average number
of hits on the expanded cache.
total-requests- The total number of requests for the server.
host-detail- The detail about the status of the server on the host.
This is a complex element with the following element children:
relation
- A specific related resource.
This is a complex element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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.
requests-count
- The total number of requests for the server
on the host.
error
- The error in processing server status.
ssl-certificate-template
-
The certificate template. When
a certificate template is specified, the App Server uses an SSL
encrypted protocol (e.g. https, davs, xccs). The certificate
template specifies the common information for the individual SSL
certificates needed for each host in the group. You can add a new
certificate template by navigating to
Security > Certificate Templates > Create
address
-
The server socket bind numeric internet address.
collation
-
The default collation for queries.
distribute-timestamps
-
Specifies the distribution of commit timestamps after updates.
request-rate
- The rate of a request (requests/sec).
queue-size
-
The maximum number of tasks allowed.
queue-limit
- The maximum number size of the queue.
expanded-tree-cache-hits
- The number of hits on the expanded cache.
expanded-tree-cache-misses
- The number of misses on the expanded cache.
expanded-tree-cache-hit-rate
- The average number of hits on the expanded cache.
expanded-tree-cache-miss-rate
- The average number of misses on the expanded cache.
fs-program-cache-hits
- The number of hits on the filesystem program cache.
fs-program-cache-misses
- The number of misses on the filesystem program cache.
db-program-cache-hits
- The number of hits on the database program cache.
db-program-cache-misses
- The number of misses on the database program cache.
env-program-cache-hits
- The number of hits on the XSLT environment program cache.
env-program-cache-misses
- The number of misses on the XSLT environment program cache.
fs-main-module-seq-cache-hits
- The number of hits on the filesystem main module sequence cache.
fs-main-module-seq-cache-misses
- The number of misses on the filesystem main module sequence cache.
db-main-module-seq-cache-hits
- The number of hits on the database main module sequence cache.
db-main-module-seq-cache-misses
- The number of misses on the database main module sequence cache.
fs-lib-module-cache-hits
- The number of hits on the filesystem library module cache.
fs-lib-module-cache-misses
- The number of misses on the filesystem library module cache.
db-lib-module-cache-hits
- The number of hits on the database library module cache.
db-lib-module-cache-misses
- The number of misses on the database library module cache.
hosts
-
The host's view of all other hosts in the cluster.
This is a complex element with the following element children:
host
-
The host connection information.
This is a complex element with the following element children:
host-name
-
The internet host name.
round-trip-count
-
The total of round-trip communications between the App Server
host and this host. A round trip is the completion of a
request sent from the App Server host to another host in the
cluster.
round-trip-time
-
The total time (as xs:dayTimeDuration) to complete the round
trips from the App Server to this host.
round-trip-rate
-
The moving average of the rate to send round trip data, in
megabytes per second.
round-trip-load
-
The moving average of the round-trip load on the server, in
seconds per second.
request-time
-
1 minute average of request time for this server.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/Admin?group-id=Default&view=status
(: Returns the status of the Admin server in the Default group. :)
|
|
|
|
GET /manage/v2/tickets/{tid}?view=process-status
|
|
 |
Summary:
Check the status of the ticket identified by {tid}.
|
Parameters:
format?
:
The format of the returned data. Can be either html,
json, or xml (default). If present, the
format parameter overrides the Accept header.
|
|
Request Headers:
Accept*:
The expected MIME type of the response. If the format
parameter is present, it takes precedence over the Accept header.
Allowed values: application/xml,
application/json, and text/html.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
If the ticket is still open, MarkLogic Server responds with status
code 200 (OK) and the response body contains status details. If the
ticket is closed, MarkLogic Server returns status code 303 and the
response body includes status details and a link back to the resource
upon which the related process was run. See the Usage Notes for an
alternative request that avoids the redirect.
|
Usage Notes:
Use the ticket system to track long-running or asynchronous operations
such as combining forests or resizing a partition. For such operations,
the Management REST API returns a ticket reference that you can use to
invoke this service and check the status of your ticket. For a completed
operation, the status information includes error details, if any.
You can avoid the redirect response for a completed ticket by omitting
the view=process-status request parameter. Leaving the
view parameter off requests the default view. Such a
request returns a status code 200 (OK), with status details in the
response body.
|
Example:
$ curl --anyauth --user user:password -X GET \
-i -H "Accept: application/xml" \
http://localhost:8002/manage/v2/tickets/6699732791380391489?view=process-status
==> Retrieve ticket status information. If the ticket is still open,
MarkLogic Server returns headers similar to the following. The
response body contains annotations and status data about the process.
HTTP/1.1 200 OK
Server: MarkLogic
Content-Type: text/plain; charset=UTF-8
Content-Length: 32
Connection: Keep-Alive
Keep-Alive: timeout=5
<ticket-process-status xmlns="http://marklogic.com/manage/tickets">
<id>6699732791380391489</id>
...
<status-properties>
<status>active</status>
<start-time>2013-09-21T12:02:54.866173-07:00</start-time>
<ticket-expiration>2013-09-28T12:02:54.866173-07:00</ticket-expiration>
<database>App-Services</database>
...
</status-properties>
...
</ticket-process-status>
|
Example:
$ curl --anyauth --user user:password -X GET \
-i -H "Accept: application/xml" \
http://localhost:8002/manage/v2/tickets/6699732791380391489?view=process-status
==> If the ticket is closed, MarkLogic Server returns a redirect
to the resource upon which the related operation was performed.
The response is similar to the following:
HTTP/1.1 303 See Other
Location: /manage/v2/forests
Content-type: application/xml
Cache-Control: no-cache
Expires: -1
Server: MarkLogic
Content-Length: 1612
Connection: Keep-Alive
Keep-Alive: timeout=5
<ticket-process-status xmlns="http://marklogic.com/manage/tickets">
<id>6699732791380391489</id>
...
<status-properties>
<status>completed</status>
<start-time>2013-09-21T12:02:54.866173-07:00</start-time>
<ticket-expiration>2013-09-28T12:02:54.866173-07:00</ticket-expiration>
<database>App-Services</database>
...
<time-consumed>PT41.128523S</time-consumed>
<errors>0</errors>
...
</status-properties>
...
</ticket-process-status>
|
|
|
|
GET /manage/v2/transactions
|
|
 |
Summary:
This resource address returns a summary of the transactions in the cluster.
|
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.
|
host-id
:
Specifies to limit the summary information to the transactions in the
specified host. The host can be identified either by id or name.
|
seconds-min
:
Return only transaction that have been running 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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK). The
response body contains the requested data.
|
Usage Notes:
The structure of the data
returned is as follows: A transaction-default-list element with the following element children:
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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 transactions in the list.
This is a complex element with the following element 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-transactions- The total number
of open transactions.
list-items
- The transactions reflected in the summary.
This is a complex element with the following element children: list-count-
list-item- A transaction reflected in the summary.
This is a complex element with the following element children:
relation
- A specific related resource.
This is a complex element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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 for the transaction.
uriref
- The path for 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.
item-properties
- The status properties of the transaction.
This is a complex element with the following element children:
seconds-elapsed
- How long the transaction has been
open.
xid
-
The Xid.
This is a complex element with the following element children:
global-transaction-id
-
The global transaction ID of a Xid.
branch-qualifier
-
The branch qualifier of a Xid.
transaction-mode
-
The mode of a transaction
transaction-timestamp
-
The timestamp of a transaction
transaction-state
-
The state of a transaction
canceled
- Has this transaction been canceled.
start-time
-
The time a backup or restore started.
time-limit
- The transaction's time limit, in seconds.
max-time-limit
- The upper bound for a transaction's time limit, in seconds.
join-size
- An indication of the current size of the join tables created under this transaction.
user
- The unique ID of the user executing the transaction.
admin
- If the transaction has admin privileges.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/transactions
(: Returns a summary of the transactions in the cluster. :)
|
|
|
|
GET /manage/v2/transactions/{id|uri}
|
|
 |
Summary:
This resource address returns information on the specified transaction. The
transaction can be identified either by id or URI. This resource address
must include the id or name of the host that executes the transaction.
|
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.
|
host-id
:
The id or name of the host that owns the transaction. This parameter
is required.
|
|
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.
|
|
Required Privilege:
This operation requires the manage-user role, or the
following privilege:
http://marklogic.com/xdmp/privileges/manage
|
Response:
Upon success, MarkLogic Server returns status code 200 (OK). The
response body contains the requested data.
|
Usage Notes:
The structure of the data
returned is as follows: A transaction-default element with the following element children:
id
name
meta
- Properties of the view rather than the resource.
This is a complex element with the following element 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 element with the following element 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 element with the following element children: relation-group- Related resources with the same type.
This is a complex element with the following element 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 element with the following element children:
qualifiers
- A list of associated resources that distinguish the resource.
This is a complex element with the following element children:
qualifier
- Another resource that qualifies the resource.
This is a complex element with the following element 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.
properties
- Characteristics of the transaction.
This is a complex element with the following element children: seconds-elapsed- How long the transaction has been
open.
xid-
The Xid.
This is a complex element with the following element children:
global-transaction-id
-
The global transaction ID of a Xid.
branch-qualifier
-
The branch qualifier of a Xid.
transaction-mode-
The mode of a transaction
transaction-timestamp-
The timestamp of a transaction
transaction-state-
The state of a transaction
canceled- Has this transaction been canceled.
start-time-
The time a backup or restore started.
time-limit- The transaction's time limit, in seconds.
max-time-limit- The upper bound for a transaction's time limit, in seconds.
join-size- An indication of the current size of the join tables created under this transaction.
user- The unique ID of the user executing the transaction.
admin- If the transaction has admin privileges.
related-views
- A list of broader or narrower views on the resource or resource type.
This is a complex element with the following element children: related-view- A broader or narrower view on the resource or resource type.
This is a complex element with the following element 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/transactions/10251787240502259323?host-id=myhost
==> Returns information on the transaction with the id 10251787240502259323
on the host, 'myhost'. :)
|
|
|
|
|
|