GET /manage/v2/databases/{id|name}/flexrep/configs/{id|name}/targets
Summary
This resource address returns the flexible replication targets for the
database.
URL Parameters
format
The format of the returned data. Can be either
html, json, or xml (default). This value overrides
the Accept header if both are present.
Request Headers
Accept
The expected MIME type of the response. If the
format parameter is present, it takes precedence over the Accept header.
Content-type
The MIME type of the data in the response
body. Depending upon the value of the format parameter or Accept header, one of
application/xml, application/json, or text/html.
Response Headers
Content-type
The MIME type of the data in the response
body. Depending upon the value of the format parameter or Accept header, one of
application/xml, application/json, or text/html.
Response
Upon success, MarkLogic Server returns status code 200 (OK), and the response
body contains the requested data. If the URI is malformed or the database does not exist, a
status code of 400 (Bad Request) is returned. A status code of 401 (Unauthorized) is returned
if the user does not have the necessary privileges.
Required Privileges
This operation requires the manage-user role, or the following
privilege:
http://marklogic.com/xdmp/privileges/manage
Usage Notes
The structure of the output returned from
this REST API is as follows:
meta
Properties of the view rather than the resource.
This is a complex structure with the following children:
uri
The path to the view.
current-time
The timestamp for when the view was generated.
elapsed-time
The time required to construct the view. The
elapsed time indicates the relative cost of generating the view. Consider
the cost when determining how frequently to request a view.
start-min
The timestamp for filtering out more recent
requests or transactions.
view-error
An error limiting the data in the view.
This is a complex structure with the following children:
error-type
The kind of error.
error-name
The name of the error.
error-code
The error identifier.
error-message
The error text.
list-items
Items of this resource type.
This is a complex structure with the following children:
list-count
The number of items of this resource type.
list-item
An item of this resource type.
This is a complex structure with the following children:
uriref
The path for a resource or list of resources.
roleref
A role that distinguishes the resource.
idref
The numeric identifier for the resource.
nameref
The name of the resource.
item-summary
related-views
A list of broader or narrower views on the resource or resource type.
This is a complex structure with the following children:
related-view
A broader or narrower view on the resource or resource type.
This is a complex structure with the following children:
view-type
The kind of view.
view-name
The name of the view.
view-uri
The path for the view.
Example
http://localhost:8002/manage/v2/databases/Documents/flexrep/configs/MyFlexConfig/targets
==> Returns the targets configured form the flexible replication configuration,
"MyFlexConfig," for the Documents database.
Stack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.
Stack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.