|
|
|
|
|
Summary:
This resource address returns summary information for the local cluster.
|
Parameters:
|
$format
:
The format of the returned data. Can be either HTML (default),
JSON, or XML.
|
|
$view
:
A specific view of the returned data. Can be either schema,
status, or query.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
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/v1/
(: 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 (default),
JSON, or XML.
|
|
$view
:
A specific view of the returned data. Can be either schema,
status, or query.
|
|
$cluster-role
:
A view of the local cluster or foreign clusters. Can be either all,
local, or foreign.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
meta- Properties of the view rather than the resource.
This is a complex 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.
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/v1/clusters
(: Returns a list of foreign clusters coupled to this cluster. :)
|
|
|
|
/manage/v1/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 (default),
JSON, or XML.
|
|
$view
:
A specific view of the returned data. Can be either schema,
status, or query.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
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/v1/clusters/Replica
(: Returns summary informaton for the foreign cluster named Replica. :)
|
|
|
|
/manage/v1/clusters/{id|name}/config
|
|
|
|
Summary:
This resource address returns configuration information for the specified foreign cluster.
|
Parameters:
|
$format
:
The format of the returned data. Can be either HTML (default),
JSON, or XML.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
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/v1/clusters/Replica/config
(: Returns configuration informaton for the foreign cluster named Replica :)
|
|
|
|
/manage/v1/clusters/{id|name}/status
|
|
|
|
Summary:
This resource address returns status information for the specified foreign cluster.
|
Parameters:
|
$format
:
The format of the returned data. Can be either HTML (default),
JSON, or XML.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
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-hostThis 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-idsThis 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/v1/clusters/Replica/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 (default),
schema,
JSON, or XML.
|
|
$view
:
A specific view of the returned data. Can be schema.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
meta- Properties of the view rather than the resource.
This is a complex 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.
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/v1/databases
(: Returns a list of the databases in the cluster. :)
|
|
|
|
/manage/v1/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 (default),
JSON, or XML.
|
|
$view
:
A specific view of the returned data. Can be either config,
counts, edit, or status.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
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/v1/databases/Documents
(: Returns information on the Documents database. :)
|
|
|
|
/manage/v1/databases/{id|name}/config
|
|
|
|
Summary:
This resource address returns the configuration information for 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 (default),
JSON, or XML.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
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-
Database enabled status.
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).
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.
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 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 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)
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 a full 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-
An atomic type specification.
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).
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-
An atomic type specification.
parent-namespace-uri-
A parent element namespace URI.
parent-localname-
One or more parent element 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).
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 parent element namespace URI.
parent-localname-
One or more parent element localnames.
namespace-uri-
A namespace URI.
localname-
One or more localnames.
collation-
A collation URI for string comparisons.
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.
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).
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).
include-root-
Includes elements starting at the document root
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, of the included
element.
attribute-namespace-uri-
Namespace of the child attribute.
attribute-localname-
Localname of the child attribute.
attribute-value-
Include 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 only elements with the specified attribute having this value.
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).
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-
An atomic type specification.
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).
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).
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 parent element namespace URI.
parent-localname-
One or more parent element 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).
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 parent element namespace URI.
parent-localname-
One or more parent element localnames.
latitude-namespace-uri-
A latitude child namespace URI.
latitude-localname-
One or more latitude child localnames.
longitude-namespace-uri-
A longitude child namespace URI.
longitude-localname-
One or more longitude child 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).
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 parent element namespace URI.
parent-localname-
One or more parent element localnames.
latitude-namespace-uri-
A latitude child namespace URI.
latitude-localname-
One or more latitude child localnames.
longitude-namespace-uri-
A longitude child namespace URI.
longitude-localname-
One or more longitude child 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).
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 foreign cluster related to the database.
foreign-database-id-
A foreign database id.
connect-forests-by-name-
Automatically connect local forests with foreign forests of the same name.
lag-limit-
The maximum transaction journal lag to the foreign database.
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-
A foreign database id.
connect-forests-by-name-
Automatically connect local forests with foreign forests of the same name.
foreign-databases-
Cluster of clusters configuration.
This is a complex element with the following element children:
foreign-database-
Foreign database.
This is a complex element with the following element children:
foreign-cluster-id-
A foreign cluster id.
foreign-database-id-
A foreign database id.
word-query- The configuration properties for word query.
This is a complex element with the following element children:
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).
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).
include-root-
Includes elements starting at the document root
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, of the included
element.
attribute-namespace-uri-
Namespace of the child attribute.
attribute-localname-
Localname of the child attribute.
attribute-value-
Include 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 only elements with the specified attribute having this value.
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).
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/v1/databases/Documents/config
(: Returns the configuration information for the Documents database. :)
|
|
|
|
/manage/v1/databases/{id|name}/counts
|
|
|
|
Summary:
This resource address returns the count information for the forests attached
to the specified database. The
database can be identified either by id or name. The count information includes the
document count, directory count, active fragment count, deleted
fragment count, and nascent fragment count.
|
Parameters:
|
$format
:
The format of the returned data. Can be either HTML (default),
JSON, or XML.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
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/v1/databases/Documents/counts
(: Returns count information for the Documents database. :)
|
|
|
|
/manage/v1/databases/{id|name}/status
|
|
|
|
Summary:
This resource address returns status information for 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 (default),
JSON, or XML.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
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-
Database enabled status.
state- The state of the database.
forests-count- The number of forests for the database.
on-disk-size- The total size of the database 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:
total-query-read-load- The sum of the moving average
of the read load in seconds per second.
total-journal-write-load- The sum of the moving average
for writing to the journal in seconds per second.
total-save-write-load- The sum of the moving average
for writing to in-memory stands in seconds per second.
total-merge-read-load- The sum of the moving average
of the read load on merges in seconds per second.
total-merge-write-load- The sum of the moving average
of the load for writing merges in seconds per second.
total-backup-read-load- The sum of the moving average
of the read load on backups in seconds per second.
total-backup-write-load- The sum of the moving average
of the load for writing backups in seconds per second.
total-restore-read-load- The sum of the moving average
of the read load on backups in seconds per second.
total-restore-write-load- The sum of the moving average
of the load for writing restores in seconds per second.
total-large-read-load- The sum of the moving average
of the read load on large documents in seconds per second.
total-large-write-load- The sum of the moving average
of the load for writing large documents in seconds per second.
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:
total-query-read-rate- The sum of the moving average
for reading query data from disk in MB per second.
total-journal-write-rate- The sum of the moving average
for writing data to the journal in MB per second.
total-save-write-rate- The sum of the moving average
for writing data to in-memory stands in MB per second.
total-merge-read-rate- The sum of the moving average
for reading merge data from disk in MB per second.
total-merge-write-rate- The sum of the moving average
of writing data for merges in MB per second.
total-backup-read-rate- The sum of the moving average
for reading backup data from disk in MB per second.
total-backup-write-rate- The sum of the moving average
for writing data for backups in MB per second.
total-restore-read-rate- The sum of the moving average
for reading restore data from disk in MB per second.
total-restore-write-rate- The sum of the moving average
for writing data for restores in MB per second.
total-large-read-rate- The sum of the moving average
for reading large documents from disk in MB per second.
total-large-write-rate- The sum of the moving average
for writing data for large documents in MB per second.
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.
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
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/v1/databases/Documents/status
(: Returns status information for the Documents database. :)
|
|
|
|
|
|
|
Summary:
This resource address returns a summary of the forests in the cluster.
|
Parameters:
|
$format
:
The format of the returned data. Can be either HTML (default),
JSON, or XML.
|
|
$view
:
A specific view of the returned data. Can be either
schema, counts, storage, 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.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
meta- Properties of the view rather than the resource.
This is a complex 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.
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/v1/forests
(: Returns a summary of the forests in the cluster. :)
|
|
|
|
/manage/v1/forests?view=status
|
|
|
|
Summary:
This resource address returns a status view of the forests in the cluster.
|
Parameters:
|
$format
:
The format of the returned data. Can be either HTML (default),
JSON, or XML.
|
|
$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.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
meta- Properties of the view rather than the resource.
This is a complex 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:
total-query-read-load- The sum of the moving average
of the read load in seconds per second.
total-journal-write-load- The sum of the moving average
for writing to the journal in seconds per second.
total-save-write-load- The sum of the moving average
for writing to in-memory stands in seconds per second.
total-merge-read-load- The sum of the moving average
of the read load on merges in seconds per second.
total-merge-write-load- The sum of the moving average
of the load for writing merges in seconds per second.
total-backup-read-load- The sum of the moving average
of the read load on backups in seconds per second.
total-backup-write-load- The sum of the moving average
of the load for writing backups in seconds per second.
total-restore-read-load- The sum of the moving average
of the read load on backups in seconds per second.
total-restore-write-load- The sum of the moving average
of the load for writing restores in seconds per second.
total-large-read-load- The sum of the moving average
of the read load on large documents in seconds per second.
total-large-write-load- The sum of the moving average
of the load for writing large documents in seconds per second.
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:
total-query-read-rate- The sum of the moving average
for reading query data from disk in MB per second.
total-journal-write-rate- The sum of the moving average
for writing data to the journal in MB per second.
total-save-write-rate- The sum of the moving average
for writing data to in-memory stands in MB per second.
total-merge-read-rate- The sum of the moving average
for reading merge data from disk in MB per second.
total-merge-write-rate- The sum of the moving average
of writing data for merges in MB per second.
total-backup-read-rate- The sum of the moving average
for reading backup data from disk in MB per second.
total-backup-write-rate- The sum of the moving average
for writing data for backups in MB per second.
total-restore-read-rate- The sum of the moving average
for reading restore data from disk in MB per second.
total-restore-write-rate- The sum of the moving average
for writing data for restores in MB per second.
total-large-read-rate- The sum of the moving average
for reading large documents from disk in MB per second.
total-large-write-rate- The sum of the moving average
for writing data for large documents in MB per second.
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.
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
compressed-tree-cache-ratio
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/v1/forests?view=status
(: Returns a status view of the forests in the cluster. :)
|
|
|
|
/manage/v1/forests?view=storage
|
|
|
|
Summary:
This resource address returns a storage view of the forests in the cluster.
|
Parameters:
|
$format
:
The format of the returned data. Can be either HTML (default),
JSON, or XML.
|
|
$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.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
meta- Properties of the view rather than the resource.
This is a complex 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 total storage needed to merge forests in MB.
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/v1/forests?view=storage
(: Returns a storage view of the forests in the cluster. :)
|
|
|
|
/manage/v1/forests/{id|name}
|
|
|
|
Summary:
This resource address returns information on a specific forest. The forest can
be identified either by id or name.
|
Parameters:
|
$format
:
The format of the returned data. Can be either HTML (default),
JSON, or XML.
|
|
$view
:
A specific view of the returned data. Can be either config,
counts, edit, or status.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
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/v1/forests/Documents
(: Returns information on the Documents forest. :)
|
|
|
|
/manage/v1/forests/{id|name}/config
|
|
|
|
Summary:
This resource address returns the configuration information for the specified forest.
The forest can be identified either by id or name.
|
Parameters:
|
$format
:
The format of the returned data. Can be either HTML (default),
JSON, or XML.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
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-
Is the forest enabled or not.
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 types of updates allowed 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-
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 resource related to the host.
foreign-database-id-
The ID of the foreign database.
foreign-forest-id-
The ID of the foreign forest.
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-
The ID of the foreign database.
foreign-forest-id-
The ID of the foreign 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/v1/Documents/config
(: Returns the configuration information for the Documents forest. :)
|
|
|
|
/manage/v1/forests/{id|name}/counts
|
|
|
|
Summary:
This resource address returns the count information for the specified forest.
The forest can
be identified either by id or name. The count information includes the stand count,
document count, directory count, reindex refragment fragment count, reindex
fragment count, and refragment document count.
|
Parameters:
|
$format
:
The format of the returned data. Can be either HTML (default),
JSON, or XML.
|
|
$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.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
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.
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-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-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 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 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 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 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 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 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 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 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 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 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 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 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 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 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.
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/v1/forests/Documents/counts?property=document-count
(: Returns the number of documents in the Documents forest. :)
|
|
|
|
/manage/v1/forests/{id|name}/status
|
|
|
|
Summary:
This resource address returns the status of the specified forest. The forest can
be identified either by id or name.
|
Parameters:
|
$format
:
The format of the returned data. Can be either HTML (default),
JSON, or XML.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
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-
Is the forest enabled or not.
updates-allowed-
The types of updates allowed 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.
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.
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.
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).
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.
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-
The ID of the foreign database.
foreign-forest-id-
The ID of the foreign forest.
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 resource related to the host.
foreign-database-id-
The ID of the foreign database.
foreign-forest-id-
The ID of the foreign forest.
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.
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/v1/forests/Documents/status
(: Returns the status of the Documents forest. :)
|
|
|
|
|
|
|
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 (default),
JSON, or XML.
|
|
$view
:
A specific view of the returned data. Can be schema.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
meta- Properties of the view rather than the resource.
This is a complex 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.
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/v1/groups
(: Returns a summary of the groups in the cluster. :)
|
|
|
|
/manage/v1/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 (default),
JSON, or XML.
|
|
$view
:
A specific view of the returned data. Can be either config,
counts, edit, or status.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
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/v1/groups/Default
(: Returns information on the Default group. :)
|
|
|
|
/manage/v1/groups/{id|name}/config
|
|
|
|
Summary:
This resource address returns the configuration information for 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 (default),
JSON, or XML.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
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-
The size of the list cache, in megabytes.
list-cache-partitions-
The number of list cache partitions.
compressed-tree-cache-size-
The size of the compressed tree cache, in megabytes.
compressed-tree-cache-partitions-
The number of compressed tree cache partitions.
compressed-tree-read-size-
The block size for random-access compressed tree file reads, in kilobytes.
expanded-tree-cache-size-
The size of the expanded tree cache, in megabytes.
expanded-tree-cache-partitions-
The number of expanded tree cache partitions.
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.
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.
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.
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/v1/Default/config
(: Returns the configuration of the Default group. :)
|
|
|
|
/manage/v1/groups/{id|name}/counts
|
|
|
|
Summary:
This resource address returns the count information for the specified group. The
group can be identified either by id or name. The count information includes the
document count, directory count, active fragment count, deleted
fragment count, and nascent fragment count.
|
Parameters:
|
$format
:
The format of the returned data. Can be either HTML (default),
JSON, or XML.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
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/v1/Default/count
(: Returns count information for the Default group. :)
|
|
|
|
/manage/v1/groups/{id|name}/status
|
|
|
|
Summary:
This resource address returns status information for 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 (default),
JSON, or XML.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
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:
total-query-read-load- The sum of the moving average
of the read load in seconds per second.
total-journal-write-load- The sum of the moving average
for writing to the journal in seconds per second.
total-save-write-load- The sum of the moving average
for writing to in-memory stands in seconds per second.
total-merge-read-load- The sum of the moving average
of the read load on merges in seconds per second.
total-merge-write-load- The sum of the moving average
of the load for writing merges in seconds per second.
total-backup-read-load- The sum of the moving average
of the read load on backups in seconds per second.
total-backup-write-load- The sum of the moving average
of the load for writing backups in seconds per second.
total-restore-read-load- The sum of the moving average
of the read load on backups in seconds per second.
total-restore-write-load- The sum of the moving average
of the load for writing restores in seconds per second.
total-large-read-load- The sum of the moving average
of the read load on large documents in seconds per second.
total-large-write-load- The sum of the moving average
of the load for writing large documents in seconds per second.
total-external-binary-read-load- The sum of the moving average
of the read load on external binary documents in seconds per second.
total-xdqp-client-receive-load- The sum of the moving average
of the receive load for an xdqp client in seconds per second.
total-xdqp-client-send-load- The sum of the moving average
of the send load for an xdqp client in seconds per second.
total-xdqp-server-receive-load- The sum of the moving average
of the receive load for an xdqp server in seconds per second.
total-xdqp-server-send-load- The sum of the moving average
of the send load for an xdqp server in seconds per second.
total-foreign-xdqp-client-receive-load- The sum of the moving average
of the receive load for a foreign xdqp client in seconds per second.
total-foreign-xdqp-client-send-load- The sum of the moving average
of the send load for a foreign xdqp client in seconds per second.
total-foreign-xdqp-server-receive-load- The sum of the moving average
of the receive load for a foreign xdqp server in seconds per second.
total-foreign-xdqp-server-send-load- The sum of the moving average
of the send load for a foreign xdqp server in seconds per second.
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:
total-query-read-rate- The sum of the moving average
for reading query data from disk in MB per second.
total-journal-write-rate- The sum of the moving average
for writing data to the journal in MB per second.
total-save-write-rate- The sum of the moving average
for writing data to in-memory stands in MB per second.
total-merge-read-rate- The sum of the moving average
for reading merge data from disk in MB per second.
total-merge-write-rate- The sum of the moving average
of writing data for merges in MB per second.
total-backup-read-rate- The sum of the moving average
for reading backup data from disk in MB per second.
total-backup-write-rate- The sum of the moving average
for writing data for backups in MB per second.
total-restore-read-rate- The sum of the moving average
for reading restore data from disk in MB per second.
total-restore-write-rate- The sum of the moving average
for writing data for restores in MB per second.
total-large-read-rate- The sum of the moving average
for reading large documents from disk in MB per second.
total-large-write-rate- The sum of the moving average
for writing data for large documents in MB per second.
total-external-binary-read-rate- The sum of the moving average
for reading external binary documents from disk in MB per second.
total-xdqp-client-receive-rate- The sum of the moving average
for receiving xdqp client messages in MB per second.
total-xdqp-client-send-rate- The sum of the moving average
for sending xdqp client messages in MB per second.
total-xdqp-server-receive-rate- The sum of the moving average
for receiving xdqp server messages in MB per second.
total-xdqp-server-send-rate- The sum of the moving average
for sending xdqp server messages in MB per second.
total-foreign-xdqp-client-receive-rate- The sum of the moving average
for receiving foreign xdqp client messages in MB per second.
total-foreign-xdqp-client-send-rate- The sum of the moving average
for sending foreign xdqp client messages in MB per second.
total-foreign-xdqp-server-receive-rate- The sum of the moving average
for receiving foreign xdqp server messages in MB per second.
total-foreign-xdqp-server-send-rate- The sum of the moving average
for sending foreign xdqp server messages in MB per second.
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/v1/groups/Default/status
(: Returns the status of the Default group. :)
|
|
|
|
|
|
|
Summary:
This resource address returns a summary of the hosts in the cluster.
|
Parameters:
|
$format
:
The format of the returned data. Can be either HTML (default),
JSON, or XML.
|
|
$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 or status.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
meta- Properties of the view rather than the resource.
This is a complex 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.
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/v1/hosts
(: Returns a summary of the hosts in the cluster. :)
|
|
|
|
/manage/v1/hosts?view=status
|
|
|
|
Summary:
This resource address returns a status summary of the hosts in the cluster.
|
Parameters:
|
$format
:
The format of the returned data. Can be either HTML (default),
JSON, or XML.
|
|
$group-id
:
Specifies to return only the hosts in the specified group. The group can
be identified either by id or name.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
meta- Properties of the view rather than the resource.
This is a complex 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:
total-query-read-load- The sum of the moving average
of the read load in seconds per second.
total-journal-write-load- The sum of the moving average
for writing to the journal in seconds per second.
total-save-write-load- The sum of the moving average
for writing to in-memory stands in seconds per second.
total-merge-read-load- The sum of the moving average
of the read load on merges in seconds per second.
total-merge-write-load- The sum of the moving average
of the load for writing merges in seconds per second.
total-backup-read-load- The sum of the moving average
of the read load on backups in seconds per second.
total-backup-write-load- The sum of the moving average
of the load for writing backups in seconds per second.
total-restore-read-load- The sum of the moving average
of the read load on backups in seconds per second.
total-restore-write-load- The sum of the moving average
of the load for writing restores in seconds per second.
total-large-read-load- The sum of the moving average
of the read load on large documents in seconds per second.
total-large-write-load- The sum of the moving average
of the load for writing large documents in seconds per second.
total-external-binary-read-load- The sum of the moving average
of the read load on external binary documents in seconds per second.
total-xdqp-client-receive-load- The sum of the moving average
of the receive load for an xdqp client in seconds per second.
total-xdqp-client-send-load- The sum of the moving average
of the send load for an xdqp client in seconds per second.
total-xdqp-server-receive-load- The sum of the moving average
of the receive load for an xdqp server in seconds per second.
total-xdqp-server-send-load- The sum of the moving average
of the send load for an xdqp server in seconds per second.
total-foreign-xdqp-client-receive-load- The sum of the moving average
of the receive load for a foreign xdqp client in seconds per second.
total-foreign-xdqp-client-send-load- The sum of the moving average
of the send load for a foreign xdqp client in seconds per second.
total-foreign-xdqp-server-receive-load- The sum of the moving average
of the receive load for a foreign xdqp server in seconds per second.
total-foreign-xdqp-server-send-load- The sum of the moving average
of the send load for a foreign xdqp server in seconds per second.
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:
total-query-read-rate- The sum of the moving average
for reading query data from disk in MB per second.
total-journal-write-rate- The sum of the moving average
for writing data to the journal in MB per second.
total-save-write-rate- The sum of the moving average
for writing data to in-memory stands in MB per second.
total-merge-read-rate- The sum of the moving average
for reading merge data from disk in MB per second.
total-merge-write-rate- The sum of the moving average
of writing data for merges in MB per second.
total-backup-read-rate- The sum of the moving average
for reading backup data from disk in MB per second.
total-backup-write-rate- The sum of the moving average
for writing data for backups in MB per second.
total-restore-read-rate- The sum of the moving average
for reading restore data from disk in MB per second.
total-restore-write-rate- The sum of the moving average
for writing data for restores in MB per second.
total-large-read-rate- The sum of the moving average
for reading large documents from disk in MB per second.
total-large-write-rate- The sum of the moving average
for writing data for large documents in MB per second.
total-external-binary-read-rate- The sum of the moving average
for reading external binary documents from disk in MB per second.
total-xdqp-client-receive-rate- The sum of the moving average
for receiving xdqp client messages in MB per second.
total-xdqp-client-send-rate- The sum of the moving average
for sending xdqp client messages in MB per second.
total-xdqp-server-receive-rate- The sum of the moving average
for receiving xdqp server messages in MB per second.
total-xdqp-server-send-rate- The sum of the moving average
for sending xdqp server messages in MB per second.
total-foreign-xdqp-client-receive-rate- The sum of the moving average
for receiving foreign xdqp client messages in MB per second.
total-foreign-xdqp-client-send-rate- The sum of the moving average
for sending foreign xdqp client messages in MB per second.
total-foreign-xdqp-server-receive-rate- The sum of the moving average
for receiving foreign xdqp server messages in MB per second.
total-foreign-xdqp-server-send-rate- The sum of the moving average
for sending foreign xdqp server messages in MB per second.
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/v1/hosts?view=status
(: Returns a status summary of the hosts in the cluster. :)
|
|
|
|
/manage/v1/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 (default),
JSON, or XML.
|
|
$view
:
A specific view of the returned data. Can be either config,
counts, edit, or status.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
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/v1/hosts/myhost
(: Returns information on the 'myhost' host. :)
|
|
|
|
/manage/v1/hosts/{id|name}/config
|
|
|
|
Summary:
This resource address returns the configuration information for the specified host.
The host can be identified either by id or name.
|
Parameters:
|
$format
:
The format of the returned data. Can be either HTML (default),
JSON, or XML.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
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 foreign server socket bind internet port number.
foreign-connect-port-
The distributed protocol foreign client socket connect internet port number.
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/v1/hosts/myhost/config
(: Returns the configuration of the 'myhost' host. :)
|
|
|
|
/manage/v1/hosts/{id|name}/counts
|
|
|
|
Summary:
This resource address returns the count information for the specified host. The
host can be identified either by id or name. The count information includes the
document count, directory count, active fragment count, deleted
fragment count, and nascent fragment count.
|
Parameters:
|
$format
:
The format of the returned data. Can be either HTML (default),
JSON, or XML.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
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/v1/host/myhost/counts
(: Returns count information for the 'myhost' host. :)
|
|
|
|
/manage/v1/hosts/{id|name}/status
|
|
|
|
Summary:
This resource address returns status information for the specified host.
The host can be identified either by id or name.
|
Parameters:
|
$format
:
The format of the returned data. Can be either HTML (default),
JSON, or XML.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
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 host 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:
total-query-read-load- The sum of the moving average
of the read load in seconds per second.
total-journal-write-load- The sum of the moving average
for writing to the journal in seconds per second.
total-save-write-load- The sum of the moving average
for writing to in-memory stands in seconds per second.
total-merge-read-load- The sum of the moving average
of the read load on merges in seconds per second.
total-merge-write-load- The sum of the moving average
of the load for writing merges in seconds per second.
total-backup-read-load- The sum of the moving average
of the read load on backups in seconds per second.
total-backup-write-load- The sum of the moving average
of the load for writing backups in seconds per second.
total-restore-read-load- The sum of the moving average
of the read load on backups in seconds per second.
total-restore-write-load- The sum of the moving average
of the load for writing restores in seconds per second.
total-large-read-load- The sum of the moving average
of the read load on large documents in seconds per second.
total-large-write-load- The sum of the moving average
of the load for writing large documents in seconds per second.
total-external-binary-read-load- The sum of the moving average
of the read load on external binary documents in seconds per second.
total-xdqp-client-receive-load- The sum of the moving average
of the receive load for an xdqp client in seconds per second.
total-xdqp-client-send-load- The sum of the moving average
of the send load for an xdqp client in seconds per second.
total-xdqp-server-receive-load- The sum of the moving average
of the receive load for an xdqp server in seconds per second.
total-xdqp-server-send-load- The sum of the moving average
of the send load for an xdqp server in seconds per second.
total-foreign-xdqp-client-receive-load- The sum of the moving average
of the receive load for a foreign xdqp client in seconds per second.
total-foreign-xdqp-client-send-load- The sum of the moving average
of the send load for a foreign xdqp client in seconds per second.
total-foreign-xdqp-server-receive-load- The sum of the moving average
of the receive load for a foreign xdqp server in seconds per second.
total-foreign-xdqp-server-send-load- The sum of the moving average
of the send load for a foreign xdqp server in seconds per second.
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:
total-query-read-rate- The sum of the moving average
for reading query data from disk in MB per second.
total-journal-write-rate- The sum of the moving average
for writing data to the journal in MB per second.
total-save-write-rate- The sum of the moving average
for writing data to in-memory stands in MB per second.
total-merge-read-rate- The sum of the moving average
for reading merge data from disk in MB per second.
total-merge-write-rate- The sum of the moving average
of writing data for merges in MB per second.
total-backup-read-rate- The sum of the moving average
for reading backup data from disk in MB per second.
total-backup-write-rate- The sum of the moving average
for writing data for backups in MB per second.
total-restore-read-rate- The sum of the moving average
for reading restore data from disk in MB per second.
total-restore-write-rate- The sum of the moving average
for writing data for restores in MB per second.
total-large-read-rate- The sum of the moving average
for reading large documents from disk in MB per second.
total-large-write-rate- The sum of the moving average
for writing data for large documents in MB per second.
total-external-binary-read-rate- The sum of the moving average
for reading external binary documents from disk in MB per second.
total-xdqp-client-receive-rate- The sum of the moving average
for receiving xdqp client messages in MB per second.
total-xdqp-client-send-rate- The sum of the moving average
for sending xdqp client messages in MB per second.
total-xdqp-server-receive-rate- The sum of the moving average
for receiving xdqp server messages in MB per second.
total-xdqp-server-send-rate- The sum of the moving average
for sending xdqp server messages in MB per second.
total-foreign-xdqp-client-receive-rate- The sum of the moving average
for receiving foreign xdqp client messages in MB per second.
total-foreign-xdqp-client-send-rate- The sum of the moving average
for sending foreign xdqp client messages in MB per second.
total-foreign-xdqp-server-receive-rate- The sum of the moving average
for receiving foreign xdqp server messages in MB per second.
total-foreign-xdqp-server-send-rate- The sum of the moving average
for sending foreign xdqp server messages in MB per second.
status-detail- The detailed status characteristics for the host.
This is a complex element with the following element children:
error-
The error in processing host status.
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 foreign server socket bind internet port number.
foreign-connect-port-
The distributed protocol foreign client socket connect internet port number.
last-startup-
The timestamp of last host startup
version-
The version of the product.
architecture-
The achitecture 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.
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.
cpus-
The number of CPUs.
cores-
The number of cores.
host-size-
The total data size of 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 backup or restore 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 ID 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 backup or restore started.
safe-restore-to-time-
The safest timestamp closest to the restore-to-time at which all restored
forests are 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 ID of the forest.
status
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-
Thee 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-
Thee 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.
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/v1/hosts/myhost/status
(: Returns the status of the 'myhost' host. :)
|
|
|
|
|
|
|
Summary:
This resource address returns the summary of all of the resources in the local cluster.
|
Parameters:
|
$format
:
The format of the returned data. Can be either HTML (default),
JSON, or XML.
|
|
$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.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
meta- Properties of the view rather than the resource.
This is a complex 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/v1/query?win-length=15
(: Returns the first 15 lines of cluster resource information. :)
|
|
|
|
|
|
|
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 (default),
JSON, or XML.
|
|
$view
:
A value of schema provides a view of the 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 (the default) indicates to return detail only for
first references.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
meta- Properties of the view rather than the resource.
This is a complex 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.
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/v1/requests
(: Returns a summary of the requests in the cluster. :)
|
|
|
|
/manage/v1/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 (default),
JSON, or XML.
|
|
$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.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
meta- Properties of the view rather than the resource.
This is a complex 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.
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/v1/requests/12741641870611184141
(: Returns information on the request with the id, 12741641870611184141. :)
|
|
|
|
|
|
|
Summary:
This resource address returns a summary of the servers in the cluster.
|
Parameters:
|
$format
:
The format of the returned data. Can be either HTML (default),
JSON, or XML.
|
|
$group-id
:
Specifies to return only the servers 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 or status.
|
|
$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.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
meta- Properties of the view rather than the resource.
This is a complex 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.
uriref- The path for a resource or list of resources.
kindref- The kind of server, which is either
http, task, webDAV, or xdbc.
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/v1/servers
(: Returns summary information for the servers in the cluster. :)
|
|
|
|
/manage/v1/servers?view=status
|
|
|
|
Summary:
This resource address returns a status summary of the servers in the cluster.
|
Parameters:
|
$format
:
The format of the returned data. Can be either HTML (default),
JSON, or XML.
|
|
$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.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
id-
An HTTP server id.
name-
An HTTP server name.
server-kind- The kind of server, which is either
http, task, webDAV, or xdbc.
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- The server is enabled.
port- The server socket bind internet port number.
root- The root document directory pathname.
display-last-login- Whether an appserver should display 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- The static content expiration interval, 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.
multi-version-concurrency-control-
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 concurrent request limit.
default-xquery-version-
An application server's default XQuery language version.
output-sgml-character-entities-
The character entities to use during output.
output-encoding-
The output encoding of the App Server.
error-handler-
The error handler used, if any.
url-rewriter-
The url rewriter used, if any.
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.
address- The server socket bind numeric internet address.
request-rate- The rate of a request (requests/sec).
queue-size- The number of tasks in the server queue.
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.
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/v1/servers?view=status
(: Returns status summary information for the servers in the cluster. :)
|
|
|
|
/manage/v1/servers/{id|name}?group-id={id|name}
|
|
|
|
Summary:
This resource address returns information on the specified server. The server can
be identified either by id or name. This resource address must include the id or
name of the group to which the server belongs.
|
Parameters:
|
$format
:
The format of the returned data. Can be either HTML (default),
JSON, or XML.
|
|
$view
:
A specific view of the returned data. Can be either config,
edit, or status.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
id-
An HTTP server id.
name-
An HTTP server name.
server-kind- The kind of server, which is either
http, task, webDAV, or xdbc.
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/v1/servers/Admin?group-id=Default
(: Returns information on the Admin server in the Default group. :)
|
|
|
|
/manage/v1/servers/{id|name}/config?group-id={id|name}
|
|
|
|
Summary:
This resource address returns configuration information for the specified server.
The server can be identified either by id or name. This resource address must include the id or
name of the group to which the server belongs.
|
Parameters:
|
$format
:
The format of the returned data. Can be either HTML (default),
JSON, or XML.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
id-
An HTTP server id.
name-
An HTTP server name.
server-kind- The kind of server, which is either
http, task, webDAV, or xdbc.
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- The server is enabled.
root- The root document directory pathname.
port- The server socket bind internet port number.
webDAV-
webDAV server versus HTTP server.
execute-
True if server executes xquery modules.
display-last-login- Whether an appserver should display 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- The static content expiration interval, in 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
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 concurrent request limit.
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-
An application server's default XQuery language version.
multi-version-concurrency-control-
output-sgml-character-entities-
The character entities to use during output.
output-encoding-
The output encoding of the App Server.
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 error handler used, if any.
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.
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 time the operation 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)
url-rewriter-
The url rewriter used, if any.
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/v1/servers/Admin/config?group-id=Default
(: Returns the configuration of the Admin server in the Default group. :)
|
|
|
|
/manage/v1/servers/{id|name}/status?group-id={id|name}
|
|
|
|
Summary:
This resource address returns status information for the specified server.
The server can be identified either by id or name. This resource address must include the id or
name of the group to which the server belongs.
|
Parameters:
|
$format
:
The format of the returned data. Can be either HTML (default),
JSON, or XML.
|
|
$host-id
:
Specifies to return the status for the server in 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.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
id-
An HTTP server id.
name-
An HTTP server name.
server-kind- The kind of server, which is either
http, task, webDAV, or xdbc.
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- The server is enabled.
port- The server socket bind internet port number.
root- The root document directory pathname.
display-last-login- Whether an appserver should display 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- The static content expiration interval, 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.
multi-version-concurrency-control-
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 concurrent request limit.
default-xquery-version-
An application server's default XQuery language version.
output-sgml-character-entities-
The character entities to use during output.
output-encoding-
The output encoding of the App Server.
error-handler-
The error handler used, if any.
url-rewriter-
The url rewriter used, if any.
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.
address- The server socket bind numeric internet address.
request-rate- The rate of a request (requests/sec).
queue-size- The number of tasks in the server queue.
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.
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/v1/servers/Admin/status?group-id=Default
(: Returns the status of the Admin server in the Default group. :)
|
|
|
|
|
|
|
Summary:
This resource address returns the aggregate status of the local cluster.
|
Parameters:
|
$format
:
The format of the returned data. Can be either HTML (default),
JSON, or XML.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
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:
total-query-read-load- The sum of the moving average
of the read load in seconds per second.
total-journal-write-load- The sum of the moving average
for writing to the journal in seconds per second.
total-save-write-load- The sum of the moving average
for writing to in-memory stands in seconds per second.
total-merge-read-load- The sum of the moving average
of the read load on merges in seconds per second.
total-merge-write-load- The sum of the moving average
of the load for writing merges in seconds per second.
total-backup-read-load- The sum of the moving average
of the read load on backups in seconds per second.
total-backup-write-load- The sum of the moving average
of the load for writing backups in seconds per second.
total-restore-read-load- The sum of the moving average
of the read load on backups in seconds per second.
total-restore-write-load- The sum of the moving average
of the load for writing restores in seconds per second.
total-large-read-load- The sum of the moving average
of the read load on large documents in seconds per second.
total-large-write-load- The sum of the moving average
of the load for writing large documents in seconds per second.
total-external-binary-read-load- The sum of the moving average
of the read load on external binary documents in seconds per second.
total-xdqp-client-receive-load- The sum of the moving average
of the receive load for an xdqp client in seconds per second.
total-xdqp-client-send-load- The sum of the moving average
of the send load for an xdqp client in seconds per second.
total-xdqp-server-receive-load- The sum of the moving average
of the receive load for an xdqp server in seconds per second.
total-xdqp-server-send-load- The sum of the moving average
of the send load for an xdqp server in seconds per second.
total-foreign-xdqp-client-receive-load- The sum of the moving average
of the receive load for a foreign xdqp client in seconds per second.
total-foreign-xdqp-client-send-load- The sum of the moving average
of the send load for a foreign xdqp client in seconds per second.
total-foreign-xdqp-server-receive-load- The sum of the moving average
of the receive load for a foreign xdqp server in seconds per second.
total-foreign-xdqp-server-send-load- The sum of the moving average
of the send load for a foreign xdqp server in seconds per second.
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:
total-query-read-rate- The sum of the moving average
for reading query data from disk in MB per second.
total-journal-write-rate- The sum of the moving average
for writing data to the journal in MB per second.
total-save-write-rate- The sum of the moving average
for writing data to in-memory stands in MB per second.
total-merge-read-rate- The sum of the moving average
for reading merge data from disk in MB per second.
total-merge-write-rate- The sum of the moving average
of writing data for merges in MB per second.
total-backup-read-rate- The sum of the moving average
for reading backup data from disk in MB per second.
total-backup-write-rate- The sum of the moving average
for writing data for backups in MB per second.
total-restore-read-rate- The sum of the moving average
for reading restore data from disk in MB per second.
total-restore-write-rate- The sum of the moving average
for writing data for restores in MB per second.
total-large-read-rate- The sum of the moving average
for reading large documents from disk in MB per second.
total-large-write-rate- The sum of the moving average
for writing data for large documents in MB per second.
total-external-binary-read-rate- The sum of the moving average
for reading external binary documents from disk in MB per second.
total-xdqp-client-receive-rate- The sum of the moving average
for receiving xdqp client messages in MB per second.
total-xdqp-client-send-rate- The sum of the moving average
for sending xdqp client messages in MB per second.
total-xdqp-server-receive-rate- The sum of the moving average
for receiving xdqp server messages in MB per second.
total-xdqp-server-send-rate- The sum of the moving average
for sending xdqp server messages in MB per second.
total-foreign-xdqp-client-receive-rate- The sum of the moving average
for receiving foreign xdqp client messages in MB per second.
total-foreign-xdqp-client-send-rate- The sum of the moving average
for sending foreign xdqp client messages in MB per second.
total-foreign-xdqp-server-receive-rate- The sum of the moving average
for receiving foreign xdqp server messages in MB per second.
total-foreign-xdqp-server-send-rate- The sum of the moving average
for sending foreign xdqp server messages in MB per second.
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.
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
compressed-tree-cache-ratio
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/v1/status
(: Returns summary aggregate status of the cluster. :)
|
|
|
|
|
|
|
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 (default),
JSON, or XML.
|
|
$view
:
A value of schema provides a view of the 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 (the default) indicates to return detail only for
first references.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
meta- Properties of the view rather than the resource.
This is a complex 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.
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/v1/transactions
(: Returns a summary of the transactions in the cluster. :)
|
|
|
|
/manage/v1/transactions/{id|uri}?host-id={id|name}
|
|
|
|
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 (default),
JSON, or XML.
|
|
Usage Notes:
The structure of the output
returned from this REST API is as follows:
meta- Properties of the view rather than the resource.
This is a complex 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.
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/v1/10251787240502259323?host-id=myhost
(: Returns information on the transaction with the id 10251787240502259323 on
the host, 'myhost'. :)
|
|
|