1e3f14395c
* [DOCS] API intro * Logstash configuration management * Reformatting * Comments from Josh * Commets from Gail * Fixed broken things
266 lines
8.5 KiB
Plaintext
266 lines
8.5 KiB
Plaintext
[role="xpack"]
|
|
[[spaces-api-resolve-copy-saved-objects-conflicts]]
|
|
=== Resolve copy saved objects to space conflicts API
|
|
++++
|
|
<titleabbrev>Resolve copy to space conflicts</titleabbrev>
|
|
++++
|
|
|
|
Overwrite specific saved objects that were returned as errors from the <<spaces-api-copy-saved-objects, Copy Saved Objects to Space API>>.
|
|
|
|
experimental["The underlying Spaces concepts are stable, but the APIs for managing Spaces are experimental."]
|
|
|
|
////
|
|
Use the appropriate heading levels for your book.
|
|
Add anchors for each section.
|
|
FYI: The section titles use attributes in case those terms change.
|
|
////
|
|
|
|
[[spaces-api-resolve-copy-saved-objects-conflicts-request]]
|
|
==== {api-request-title}
|
|
////
|
|
This section show the basic endpoint, without the body or optional parameters.
|
|
Variables should use <...> syntax.
|
|
If an API supports both PUT and POST, include both here.
|
|
////
|
|
|
|
`POST /api/spaces/_resolve_copy_saved_objects_errors`
|
|
|
|
`POST /s/<space_id>/api/spaces/_resolve_copy_saved_objects_errors`
|
|
|
|
|
|
|
|
[[spaces-api-resolve-copy-saved-objects-conflicts-prereqs]]
|
|
==== {api-prereq-title}
|
|
////
|
|
Optional list of prerequisites.
|
|
|
|
For example:
|
|
|
|
* A snapshot of an index created in 5.x can be restored to 6.x. You must...
|
|
* If the {es} {security-features} are enabled, you must have `write`, `monitor`,
|
|
and `manage_follow_index` index privileges...
|
|
////
|
|
* Executed the <<spaces-api-copy-saved-objects, Copy Saved Objects to Space API>>, which returned one or more `conflict` errors that you wish to resolve.
|
|
|
|
////
|
|
[[spaces-api-resolve-copy-saved-objects-conflicts-desc]]
|
|
==== {api-description-title}
|
|
|
|
Allows saved objects to be selectively overridden in the target spaces.
|
|
////
|
|
|
|
////
|
|
Add a more detailed description the context.
|
|
Link to related APIs if appropriate.
|
|
|
|
Guidelines for parameter documentation
|
|
***************************************
|
|
* Use a definition list.
|
|
* End each definition with a period.
|
|
* Include whether the parameter is Optional or Required and the data type.
|
|
* Include default values as the last sentence of the first paragraph.
|
|
* Include a range of valid values, if applicable.
|
|
* If the parameter requires a specific delimiter for multiple values, say so.
|
|
* If the parameter supports wildcards, ditto.
|
|
* For large or nested objects, consider linking to a separate definition list.
|
|
***************************************
|
|
////
|
|
|
|
|
|
[[spaces-api-resolve-copy-saved-objects-conflicts-path-params]]
|
|
==== {api-path-parms-title}
|
|
////
|
|
A list of all the parameters within the path of the endpoint (before the query string (?)).
|
|
|
|
For example:
|
|
`<follower_index>`::
|
|
(Required, string) Name of the follower index
|
|
////
|
|
`space_id`::
|
|
(Optional, string) Identifies the source space from which saved objects will be copied. If `space_id` is not specified in the URL, the default space is used. Must be the same value that was used during the failed <<spaces-api-copy-saved-objects, Copy Saved Objects to Space>> operation.
|
|
|
|
////
|
|
[[spaces-api-resolve-copy-saved-objects-conflicts-request-params]]
|
|
==== {api-query-parms-title}
|
|
////
|
|
////
|
|
A list of the parameters in the query string of the endpoint (after the ?).
|
|
|
|
For example:
|
|
`wait_for_active_shards`::
|
|
(Optional, integer) Specifies the number of shards to wait on being active before
|
|
responding. A shard must be restored from the leader index being active.
|
|
Restoring a follower shard requires transferring all the remote Lucene segment
|
|
files to the follower index. The default is `0`, which means waiting on none of
|
|
the shards to be active.
|
|
////
|
|
|
|
[[spaces-api-resolve-copy-saved-objects-conflicts-request-body]]
|
|
==== {api-request-body-title}
|
|
////
|
|
A list of the properties you can specify in the body of the request.
|
|
|
|
For example:
|
|
`remote_cluster`::
|
|
(Required, string) The <<modules-remote-clusters,remote cluster>> that contains
|
|
the leader index.
|
|
|
|
`leader_index`::
|
|
(Required, string) The name of the index in the leader cluster to follow.
|
|
////
|
|
`objects` ::
|
|
(Required, object array) The saved objects to copy. Must be the same value that was used during the failed <<spaces-api-copy-saved-objects, Copy Saved Objects to Space>> operation.
|
|
`type` :::
|
|
(Required, string) The saved object type.
|
|
`id` :::
|
|
(Required, string) The saved object id.
|
|
|
|
`includeReferences` ::
|
|
(Optional, boolean) When set to `true`, all saved objects related to the specified saved objects will also be copied into the target spaces. You must set this to the same value that you used when executing the <<spaces-api-copy-saved-objects, Copy Saved Objects to Space API>>. The default value is `false`.
|
|
|
|
`retries`::
|
|
(Required, object) The retry operations to attempt. Object keys represent the target space ids.
|
|
`<space_id>` :::
|
|
(Required, array) The the conflicts to resolve for the indicated `<space_id>`.
|
|
`type` ::::
|
|
(Required, string) The saved object type.
|
|
`id` ::::
|
|
(Required, string) The saved object id.
|
|
`overwrite` ::::
|
|
(Required, boolean) when set to `true`, the saved object from the source space (desigated by the <<spaces-api-resolve-copy-saved-objects-conflicts-path-params, `space_id` path parameter>>) will overwrite the the conflicting object in the destination space. When `false`, this does nothing.
|
|
|
|
|
|
[[spaces-api-resolve-copy-saved-objects-conflicts-response-body]]
|
|
==== {api-response-body-title}
|
|
////
|
|
Response body is only required for detailed responses.
|
|
|
|
For example:
|
|
`auto_follow_stats`::
|
|
(object) An object representing stats for the auto-follow coordinator. This
|
|
object consists of the following fields:
|
|
|
|
`auto_follow_stats.number_of_successful_follow_indices`:::
|
|
(long) the number of indices that the auto-follow coordinator successfully
|
|
followed
|
|
...
|
|
|
|
////
|
|
|
|
`<space_id>`::
|
|
(object) Specifies the dynamic keys that are included in the response. An object describing the result of the copy operation for this particular space.
|
|
`success`:::
|
|
(boolean) Indicates if the copy operation was successful. Note that some objects may have been copied even if this is set to `false`. Consult the `successCount` and `errors` properties of the response for additional information.
|
|
`successCount`:::
|
|
(number) The number of objects that were successfully copied.
|
|
`errors`:::
|
|
(Optional, array) Collection of any errors that were encountered during the copy operation. If any errors are reported, then the `success` flag will be set to `false`.
|
|
`id`::::
|
|
(string) The saved object id which failed to copy.
|
|
`type`::::
|
|
(string) The type of saved object which failed to copy.
|
|
`error`::::
|
|
(object) The error which caused the copy operation to fail.
|
|
`type`:::::
|
|
(string) Indicates the type of error. May be one of: `unsupported_type`, `missing_references`, `unknown`.
|
|
|
|
////
|
|
[[spaces-api-resolve-copy-saved-objects-conflicts-response-codes]]
|
|
==== {api-response-codes-title}
|
|
////
|
|
////
|
|
Response codes are only required when needed to understand the response body.
|
|
|
|
For example:
|
|
`200`::
|
|
Indicates all listed indices or index aliases exist.
|
|
|
|
`404`::
|
|
Indicates one or more listed indices or index aliases **do not** exist.
|
|
////
|
|
|
|
|
|
[[spaces-api-resolve-copy-saved-objects-conflicts-example]]
|
|
==== {api-examples-title}
|
|
////
|
|
Optional brief example.
|
|
Use an 'Examples' heading if you include multiple examples.
|
|
|
|
|
|
[source,js]
|
|
----
|
|
PUT /follower_index/_ccr/follow?wait_for_active_shards=1
|
|
{
|
|
"remote_cluster" : "remote_cluster",
|
|
"leader_index" : "leader_index",
|
|
"max_read_request_operation_count" : 1024,
|
|
"max_outstanding_read_requests" : 16,
|
|
"max_read_request_size" : "1024k",
|
|
"max_write_request_operation_count" : 32768,
|
|
"max_write_request_size" : "16k",
|
|
"max_outstanding_write_requests" : 8,
|
|
"max_write_buffer_count" : 512,
|
|
"max_write_buffer_size" : "512k",
|
|
"max_retry_delay" : "10s",
|
|
"read_poll_timeout" : "30s"
|
|
}
|
|
----
|
|
// CONSOLE
|
|
// TEST[setup:remote_cluster_and_leader_index]
|
|
|
|
The API returns the following result:
|
|
|
|
[source,js]
|
|
----
|
|
{
|
|
"follow_index_created" : true,
|
|
"follow_index_shards_acked" : true,
|
|
"index_following_started" : true
|
|
}
|
|
----
|
|
// TESTRESPONSE
|
|
////
|
|
|
|
The following example overwrites an index pattern in the marketing space, and a visualization in the sales space.
|
|
|
|
[source,js]
|
|
----
|
|
POST api/spaces/_resolve_copy_saved_objects_errors
|
|
{
|
|
"objects": [{
|
|
"type": "dashboard",
|
|
"id": "my-dashboard"
|
|
}],
|
|
"includeReferences": true,
|
|
"retries": {
|
|
"marketing": [{
|
|
"type": "index-pattern",
|
|
"id": "my-pattern",
|
|
"overwrite": true
|
|
}],
|
|
"sales": [{
|
|
"type": "visualization",
|
|
"id": "my-viz",
|
|
"overwrite": true
|
|
}]
|
|
}
|
|
}
|
|
----
|
|
// KIBANA
|
|
|
|
The API returns the following result:
|
|
|
|
[source,js]
|
|
----
|
|
{
|
|
"marketing": {
|
|
"success": true,
|
|
"successCount": 1
|
|
},
|
|
"sales": {
|
|
"success": true,
|
|
"successCount": 1
|
|
}
|
|
}
|
|
----
|