-
Notifications
You must be signed in to change notification settings - Fork 115
[DOCS] Adds API examples for autoscaling, cat, ccr, and cluster APIs #2651
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
1412c32
[DOCS] Adds API examples for autoscaling, cat, ccr, and cluster APIs.
szabosteve cca1f39
[DOCS] Style.
szabosteve 4938eea
Apply suggestions from code review
szabosteve 39156d4
Apply suggestions from code review
szabosteve 22507bd
Update specification/autoscaling/put_autoscaling_policy/examples/requ…
szabosteve File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
5 changes: 5 additions & 0 deletions
5
..._policy/examples/200_response/autoscalingApisDeleteAutoscalingPolicyResponseExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "summary": "autoscaling/apis/delete-autoscaling-policy.asciidoc:70", | ||
| "description": "", | ||
| "value": "{\n \"acknowledged\": true\n}" | ||
| } | ||
5 changes: 5 additions & 0 deletions
5
...capacity/examples/200_response/autoscalingApisGetAutoscalingCapacityResponseExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "summary": "autoscaling/apis/get-autoscaling-capacity.asciidoc:270", | ||
szabosteve marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "description": "", | ||
| "value": "{\n policies: {}\n}" | ||
| } | ||
5 changes: 5 additions & 0 deletions
5
...ing_policy/examples/200_response/autoscalingApisGetAutoscalingPolicyResponseExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "summary": "autoscaling/apis/get-autoscaling-policy.asciidoc:76", | ||
szabosteve marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "description": "", | ||
| "value": "{\n \"roles\": <roles>,\n \"deciders\": <deciders>\n}" | ||
| } | ||
5 changes: 5 additions & 0 deletions
5
...ing_policy/examples/200_response/autoscalingApisPutAutoscalingPolicyResponseExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "summary": "autoscaling/apis/put-autoscaling-policy.asciidoc:82", | ||
szabosteve marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "description": "", | ||
| "value": "{\n \"acknowledged\": true\n}" | ||
| } | ||
6 changes: 6 additions & 0 deletions
6
...oscaling/put_autoscaling_policy/examples/request/PutAutoscalingPolicyRequestExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "summary": "autoscaling/apis/put-autoscaling-policy.asciidoc:16", | ||
szabosteve marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "method_request": "PUT /_autoscaling/policy/<name>", | ||
| "description": "", | ||
| "value": "{\n \"roles\": [],\n \"deciders\": {\n \"fixed\": {\n }\n }\n}" | ||
| } | ||
6 changes: 6 additions & 0 deletions
6
...oscaling/put_autoscaling_policy/examples/request/PutAutoscalingPolicyRequestExample2.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "summary": "autoscaling/apis/put-autoscaling-policy.asciidoc:67", | ||
szabosteve marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "method_request": "PUT /_autoscaling/policy/my_autoscaling_policy", | ||
| "description": "", | ||
| "value": "{\n \"roles\" : [ \"data_hot\" ],\n \"deciders\": {\n \"fixed\": {\n }\n }\n}" | ||
| } | ||
5 changes: 5 additions & 0 deletions
5
.../ml_data_frame_analytics/examples/200_response/catDataframeanalyticsResponseExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "summary": "cat/dataframeanalytics.asciidoc:137", | ||
szabosteve marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "description": "", | ||
| "value": "id create_time type state\nclassifier_job_1 2020-02-12T11:49:09.594Z classification stopped\nclassifier_job_2 2020-02-12T11:49:14.479Z classification stopped\nclassifier_job_3 2020-02-12T11:49:16.928Z classification stopped\nclassifier_job_4 2020-02-12T11:49:19.127Z classification stopped\nclassifier_job_5 2020-02-12T11:49:21.349Z classification stopped" | ||
| } | ||
5 changes: 5 additions & 0 deletions
5
specification/cat/ml_datafeeds/examples/200_response/catDatafeedsResponseExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "summary": "cat/datafeeds.asciidoc:130", | ||
szabosteve marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "description": "", | ||
| "value": "id state buckets.count search.count\ndatafeed-high_sum_total_sales stopped 743 7\ndatafeed-low_request_rate stopped 1457 3\ndatafeed-response_code_rates stopped 1460 18\ndatafeed-url_scanning stopped 1460 18" | ||
| } | ||
5 changes: 5 additions & 0 deletions
5
specification/cat/ml_jobs/examples/200_response/catAnomalyDetectorsResponseExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "summary": "cat/anomaly-detectors.asciidoc:287", | ||
szabosteve marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "description": "", | ||
| "value": "id s dpr mb\nhigh_sum_total_sales closed 14022 1.5mb\nlow_request_rate closed 1216 40.5kb\nresponse_code_rates closed 28146 132.7kb\nurl_scanning closed 28146 501.6kb" | ||
| } | ||
5 changes: 5 additions & 0 deletions
5
...fication/cat/ml_trained_models/examples/200_response/catTrainedmodelResponseExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "summary": "cat/trainedmodel.asciidoc:125", | ||
szabosteve marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "description": "", | ||
| "value": "id created_by operations license create_time version\nddddd-1580216177138 _xpack 196 PLATINUM 2020-01-28T12:56:17.138Z 8.0.0\nflight-regress-1580215685537 _xpack 102 PLATINUM 2020-01-28T12:48:05.537Z 8.0.0\nlang_ident_model_1 _xpack 39629 BASIC 2019-12-05T12:28:34.594Z 7.6.0" | ||
| } | ||
5 changes: 5 additions & 0 deletions
5
specification/cat/tasks/examples/200_response/catTasksResponseExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "summary": "cat/tasks.asciidoc:86", | ||
szabosteve marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "description": "", | ||
| "value": "action task_id parent_task_id type start_time timestamp running_time ip node\ncluster:monitor/tasks/lists[n] oTUltX4IQMOUUVeiohTt8A:124 oTUltX4IQMOUUVeiohTt8A:123 direct 1458585884904 01:48:24 44.1micros 127.0.0.1:9300 oTUltX4IQMOUUVeiohTt8A\ncluster:monitor/tasks/lists oTUltX4IQMOUUVeiohTt8A:123 - transport 1458585884904 01:48:24 186.2micros 127.0.0.1:9300 oTUltX4IQMOUUVeiohTt8A" | ||
| } | ||
5 changes: 5 additions & 0 deletions
5
specification/cat/transforms/examples/200_response/catTransformsResponseExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "summary": "cat/transforms.asciidoc:197", | ||
szabosteve marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "description": "", | ||
| "value": "[\n {\n \"id\" : \"ecommerce_transform\",\n \"state\" : \"started\",\n \"checkpoint\" : \"1\",\n \"documents_processed\" : \"705\",\n \"checkpoint_progress\" : \"100.00\",\n \"changes_last_detection_time\" : null\n }\n]" | ||
| } | ||
5 changes: 5 additions & 0 deletions
5
...ttern/examples/200_response/ccrApisAutoFollowDeleteAutoFollowPatternResponseExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "summary": "ccr/apis/auto-follow/delete-auto-follow-pattern.asciidoc:77", | ||
szabosteve marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "description": "", | ||
| "value": "{\n \"acknowledged\" : true\n}" | ||
| } | ||
5 changes: 5 additions & 0 deletions
5
specification/ccr/follow/examples/200_response/ccrApisFollowPutFollowResponseExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "summary": "ccr/apis/follow/put-follow.asciidoc:133", | ||
szabosteve marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "description": "", | ||
| "value": "{\n \"follow_index_created\" : true,\n \"follow_index_shards_acked\" : true,\n \"index_following_started\" : true\n}" | ||
| } | ||
6 changes: 6 additions & 0 deletions
6
specification/ccr/follow/examples/request/ccrApisFollowPutFollowRequestExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "summary": "ccr/apis/follow/put-follow.asciidoc:24", | ||
szabosteve marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "method_request": "PUT /<follower_index>/_ccr/follow?wait_for_active_shards=1", | ||
| "description": "", | ||
| "value": "{\n \"remote_cluster\" : \"<remote_cluster>\",\n \"leader_index\" : \"<leader_index>\"\n}" | ||
| } | ||
6 changes: 6 additions & 0 deletions
6
specification/ccr/follow/examples/request/ccrApisFollowPutFollowRequestExample2.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "summary": "ccr/apis/follow/put-follow.asciidoc:85", | ||
szabosteve marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "method_request": "PUT /.ds-logs-mysql-default_copy-2022-01-01-000001/_ccr/follow", | ||
| "description": "", | ||
| "value": "{\n \"remote_cluster\" : \"remote_cluster\",\n \"leader_index\" : \".ds-logs-mysql-default-2022-01-01-000001\",\n \"data_stream_name\": \"logs-mysql-default_copy\"\n}" | ||
| } | ||
6 changes: 6 additions & 0 deletions
6
specification/ccr/follow/examples/request/ccrApisFollowPutFollowRequestExample3.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "summary": "ccr/apis/follow/put-follow.asciidoc:108", | ||
szabosteve marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "method_request": "PUT /follower_index/_ccr/follow?wait_for_active_shards=1", | ||
| "description": "", | ||
| "value": "{\n \"remote_cluster\" : \"remote_cluster\",\n \"leader_index\" : \"leader_index\",\n \"settings\": {\n \"index.number_of_replicas\": 0\n },\n \"max_read_request_operation_count\" : 1024,\n \"max_outstanding_read_requests\" : 16,\n \"max_read_request_size\" : \"1024k\",\n \"max_write_request_operation_count\" : 32768,\n \"max_write_request_size\" : \"16k\",\n \"max_outstanding_write_requests\" : 8,\n \"max_write_buffer_count\" : 512,\n \"max_write_buffer_size\" : \"512k\",\n \"max_retry_delay\" : \"10s\",\n \"read_poll_timeout\" : \"30s\"\n}" | ||
| } | ||
5 changes: 5 additions & 0 deletions
5
...ion/ccr/follow_info/examples/200_response/ccrApisFollowGetFollowInfoResponseExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "summary": "ccr/apis/follow/get-follow-info.asciidoc:150", | ||
szabosteve marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "description": "", | ||
| "value": "{\n \"follower_indices\": [\n {\n \"follower_index\": \"follower_index\",\n \"remote_cluster\": \"remote_cluster\",\n \"leader_index\": \"leader_index\",\n \"status\": \"active\",\n \"parameters\": {\n \"max_read_request_operation_count\": 5120,\n \"max_read_request_size\": \"32mb\",\n \"max_outstanding_read_requests\": 12,\n \"max_write_request_operation_count\": 5120,\n \"max_write_request_size\": \"9223372036854775807b\",\n \"max_outstanding_write_requests\": 9,\n \"max_write_buffer_count\": 2147483647,\n \"max_write_buffer_size\": \"512mb\",\n \"max_retry_delay\": \"500ms\",\n \"read_poll_timeout\": \"1m\"\n }\n }\n ]\n}" | ||
| } | ||
5 changes: 5 additions & 0 deletions
5
...ion/ccr/follow_info/examples/200_response/ccrApisFollowGetFollowInfoResponseExample2.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "summary": "ccr/apis/follow/get-follow-info.asciidoc:192", | ||
szabosteve marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "description": "", | ||
| "value": "{\n \"follower_indices\": [\n {\n \"follower_index\": \"follower_index\",\n \"remote_cluster\": \"remote_cluster\",\n \"leader_index\": \"leader_index\",\n \"status\": \"paused\"\n }\n ]\n}" | ||
| } | ||
5 changes: 5 additions & 0 deletions
5
...n/ccr/follow_stats/examples/200_response/ccrApisFollowGetFollowStatsResponseExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "summary": "ccr/apis/follow/get-follow-stats.asciidoc:226", | ||
szabosteve marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "description": "", | ||
| "value": "{\n \"indices\" : [\n {\n \"index\" : \"follower_index\",\n \"total_global_checkpoint_lag\" : 256,\n \"shards\" : [\n {\n \"remote_cluster\" : \"remote_cluster\",\n \"leader_index\" : \"leader_index\",\n \"follower_index\" : \"follower_index\",\n \"shard_id\" : 0,\n \"leader_global_checkpoint\" : 1024,\n \"leader_max_seq_no\" : 1536,\n \"follower_global_checkpoint\" : 768,\n \"follower_max_seq_no\" : 896,\n \"last_requested_seq_no\" : 897,\n \"outstanding_read_requests\" : 8,\n \"outstanding_write_requests\" : 2,\n \"write_buffer_operation_count\" : 64,\n \"follower_mapping_version\" : 4,\n \"follower_settings_version\" : 2,\n \"follower_aliases_version\" : 8,\n \"total_read_time_millis\" : 32768,\n \"total_read_remote_exec_time_millis\" : 16384,\n \"successful_read_requests\" : 32,\n \"failed_read_requests\" : 0,\n \"operations_read\" : 896,\n \"bytes_read\" : 32768,\n \"total_write_time_millis\" : 16384,\n \"write_buffer_size_in_bytes\" : 1536,\n \"successful_write_requests\" : 16,\n \"failed_write_requests\" : 0,\n \"operations_written\" : 832,\n \"read_exceptions\" : [ ],\n \"time_since_last_read_millis\" : 8\n }\n ]\n }\n ]\n}" | ||
| } | ||
5 changes: 5 additions & 0 deletions
5
...orget_follower/examples/200_response/ccrApisFollowPostForgetFollowerResponseExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "summary": "ccr/apis/follow/post-forget-follower.asciidoc:52", | ||
szabosteve marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "description": "", | ||
| "value": "{\n \"_shards\" : {\n \"total\" : 1,\n \"successful\" : 1,\n \"failed\" : 0,\n \"failures\" : [ ]\n }\n}" | ||
| } | ||
5 changes: 5 additions & 0 deletions
5
...orget_follower/examples/200_response/ccrApisFollowPostForgetFollowerResponseExample2.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "summary": "ccr/apis/follow/post-forget-follower.asciidoc:147", | ||
szabosteve marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "description": "", | ||
| "value": "{\n \"_shards\" : {\n \"total\" : 1,\n \"successful\" : 1,\n \"failed\" : 0,\n \"failures\" : [ ]\n }\n}" | ||
| } | ||
6 changes: 6 additions & 0 deletions
6
.../ccr/forget_follower/examples/request/ccrApisFollowPostForgetFollowerRequestExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "summary": "ccr/apis/follow/post-forget-follower.asciidoc:35", | ||
szabosteve marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "method_request": "POST /<leader_index>/_ccr/forget_follower", | ||
| "description": "", | ||
| "value": "{\n \"follower_cluster\" : \"<follower_cluster>\",\n \"follower_index\" : \"<follower_index>\",\n \"follower_index_uuid\" : \"<follower_index_uuid>\",\n \"leader_remote_cluster\" : \"<leader_remote_cluster>\"\n}" | ||
| } | ||
6 changes: 6 additions & 0 deletions
6
.../ccr/forget_follower/examples/request/ccrApisFollowPostForgetFollowerRequestExample2.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "summary": "ccr/apis/follow/post-forget-follower.asciidoc:133", | ||
szabosteve marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| "method_request": "POST /leader_index/_ccr/forget_follower", | ||
| "description": "", | ||
| "value": "{\n \"follower_cluster\" : \"follower_cluster\",\n \"follower_index\" : \"follower_index\",\n \"follower_index_uuid\" : \"vYpnaWPRQB6mNspmoCeYyA\",\n \"leader_remote_cluster\" : \"leader_cluster\"\n}" | ||
| } | ||
5 changes: 5 additions & 0 deletions
5
..._pattern/examples/200_response/ccrApisAutoFollowGetAutoFollowPatternResponseExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "summary": "ccr/apis/auto-follow/get-auto-follow-pattern.asciidoc:95", | ||
| "description": "", | ||
| "value": "{\n \"patterns\": [\n {\n \"name\": \"my_auto_follow_pattern\",\n \"pattern\": {\n \"active\": true,\n \"remote_cluster\" : \"remote_cluster\",\n \"leader_index_patterns\" :\n [\n \"leader_index*\"\n ],\n \"leader_index_exclusion_patterns\":\n [\n \"leader_index_001\"\n ],\n \"follow_index_pattern\" : \"{{leader_index}}-follower\"\n }\n }\n ]\n}" | ||
| } |
5 changes: 5 additions & 0 deletions
5
...attern/examples/200_response/ccrApisAutoFollowPauseAutoFollowPatternResponseExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "summary": "ccr/apis/auto-follow/pause-auto-follow-pattern.asciidoc:87", | ||
| "description": "", | ||
| "value": "{\n \"acknowledged\" : true\n}" | ||
| } |
5 changes: 5 additions & 0 deletions
5
.../ccr/pause_follow/examples/200_response/ccrApisFollowPostPauseFollowResponseExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "summary": "ccr/apis/follow/post-pause-follow.asciidoc:75", | ||
| "description": "", | ||
| "value": "{\n \"acknowledged\" : true\n}" | ||
| } |
5 changes: 5 additions & 0 deletions
5
..._pattern/examples/200_response/ccrApisAutoFollowPutAutoFollowPatternResponseExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "summary": "ccr/apis/auto-follow/put-auto-follow-pattern.asciidoc:142", | ||
| "description": "", | ||
| "value": "{\n \"acknowledged\" : true\n}" | ||
| } |
6 changes: 6 additions & 0 deletions
6
...follow_pattern/examples/request/ccrApisAutoFollowPutAutoFollowPatternRequestExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "summary": "ccr/apis/auto-follow/put-auto-follow-pattern.asciidoc:14", | ||
| "method_request": "PUT /_ccr/auto_follow/<auto_follow_pattern_name>", | ||
| "description": "", | ||
| "value": "{\n \"remote_cluster\" : \"<remote_cluster>\",\n \"leader_index_patterns\" :\n [\n \"<leader_index_pattern>\"\n ],\n \"leader_index_exclusion_patterns\":\n [\n \"<leader_index_exclusion_pattern>\"\n ],\n \"follow_index_pattern\" : \"<follow_index_pattern>\"\n}" | ||
| } |
6 changes: 6 additions & 0 deletions
6
...follow_pattern/examples/request/ccrApisAutoFollowPutAutoFollowPatternRequestExample2.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "summary": "ccr/apis/auto-follow/put-auto-follow-pattern.asciidoc:113", | ||
| "method_request": "PUT /_ccr/auto_follow/my_auto_follow_pattern", | ||
| "description": "", | ||
| "value": "{\n \"remote_cluster\" : \"remote_cluster\",\n \"leader_index_patterns\" :\n [\n \"leader_index*\"\n ],\n \"follow_index_pattern\" : \"{{leader_index}}-follower\",\n \"settings\": {\n \"index.number_of_replicas\": 0\n },\n \"max_read_request_operation_count\" : 1024,\n \"max_outstanding_read_requests\" : 16,\n \"max_read_request_size\" : \"1024k\",\n \"max_write_request_operation_count\" : 32768,\n \"max_write_request_size\" : \"16k\",\n \"max_outstanding_write_requests\" : 8,\n \"max_write_buffer_count\" : 512,\n \"max_write_buffer_size\" : \"512k\",\n \"max_retry_delay\" : \"10s\",\n \"read_poll_timeout\" : \"30s\"\n}" | ||
| } |
5 changes: 5 additions & 0 deletions
5
...ttern/examples/200_response/ccrApisAutoFollowResumeAutoFollowPatternResponseExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "summary": "ccr/apis/auto-follow/resume-auto-follow-pattern.asciidoc:88", | ||
| "description": "", | ||
| "value": "{\n \"acknowledged\" : true\n}" | ||
| } |
5 changes: 5 additions & 0 deletions
5
...cr/resume_follow/examples/200_response/ccrApisFollowPostResumeFollowResponseExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "summary": "ccr/apis/follow/post-resume-follow.asciidoc:103", | ||
| "description": "", | ||
| "value": "{\n \"acknowledged\" : true\n}" | ||
| } |
6 changes: 6 additions & 0 deletions
6
...tion/ccr/resume_follow/examples/request/ccrApisFollowPostResumeFollowRequestExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "summary": "ccr/apis/follow/post-resume-follow.asciidoc:37", | ||
| "method_request": "POST /<follower_index>/_ccr/resume_follow", | ||
| "description": "", | ||
| "value": "{\n}" | ||
| } |
6 changes: 6 additions & 0 deletions
6
...tion/ccr/resume_follow/examples/request/ccrApisFollowPostResumeFollowRequestExample2.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "summary": "ccr/apis/follow/post-resume-follow.asciidoc:84", | ||
| "method_request": "POST /follower_index/_ccr/resume_follow", | ||
| "description": "", | ||
| "value": "{\n \"max_read_request_operation_count\" : 1024,\n \"max_outstanding_read_requests\" : 16,\n \"max_read_request_size\" : \"1024k\",\n \"max_write_request_operation_count\" : 32768,\n \"max_write_request_size\" : \"16k\",\n \"max_outstanding_write_requests\" : 8,\n \"max_write_buffer_count\" : 512,\n \"max_write_buffer_size\" : \"512k\",\n \"max_retry_delay\" : \"10s\",\n \"read_poll_timeout\" : \"30s\"\n}" | ||
| } |
5 changes: 5 additions & 0 deletions
5
specification/ccr/stats/examples/200_response/ccrApisGetCcrStatsResponseExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "summary": "ccr/apis/get-ccr-stats.asciidoc:110", | ||
| "description": "", | ||
| "value": "{\n \"auto_follow_stats\" : {\n \"number_of_failed_follow_indices\" : 0,\n \"number_of_failed_remote_cluster_state_requests\" : 0,\n \"number_of_successful_follow_indices\" : 1,\n \"recent_auto_follow_errors\" : [],\n \"auto_followed_clusters\" : []\n },\n \"follow_stats\" : {\n \"indices\" : [\n {\n \"index\" : \"follower_index\",\n \"total_global_checkpoint_lag\" : 256,\n \"shards\" : [\n {\n \"remote_cluster\" : \"remote_cluster\",\n \"leader_index\" : \"leader_index\",\n \"follower_index\" : \"follower_index\",\n \"shard_id\" : 0,\n \"leader_global_checkpoint\" : 1024,\n \"leader_max_seq_no\" : 1536,\n \"follower_global_checkpoint\" : 768,\n \"follower_max_seq_no\" : 896,\n \"last_requested_seq_no\" : 897,\n \"outstanding_read_requests\" : 8,\n \"outstanding_write_requests\" : 2,\n \"write_buffer_operation_count\" : 64,\n \"follower_mapping_version\" : 4,\n \"follower_settings_version\" : 2,\n \"follower_aliases_version\" : 8,\n \"total_read_time_millis\" : 32768,\n \"total_read_remote_exec_time_millis\" : 16384,\n \"successful_read_requests\" : 32,\n \"failed_read_requests\" : 0,\n \"operations_read\" : 896,\n \"bytes_read\" : 32768,\n \"total_write_time_millis\" : 16384,\n \"write_buffer_size_in_bytes\" : 1536,\n \"successful_write_requests\" : 16,\n \"failed_write_requests\" : 0,\n \"operations_written\" : 832,\n \"read_exceptions\" : [ ],\n \"time_since_last_read_millis\" : 8\n }\n ]\n }\n ]\n }\n}" | ||
| } |
5 changes: 5 additions & 0 deletions
5
...ication/ccr/unfollow/examples/200_response/ccrApisFollowPostUnfollowResponseExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "summary": "ccr/apis/follow/post-unfollow.asciidoc:82", | ||
| "description": "", | ||
| "value": "{\n \"acknowledged\" : true\n}" | ||
| } |
5 changes: 5 additions & 0 deletions
5
...er/allocation_explain/examples/200_response/clusterAllocationExplainResponseExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "summary": "cluster/allocation-explain.asciidoc:115", | ||
| "description": "", | ||
| "value": "{\n \"index\" : \"my-index-000001\",\n \"shard\" : 0,\n \"primary\" : true,\n \"current_state\" : \"unassigned\", <1>\n \"unassigned_info\" : {\n \"reason\" : \"INDEX_CREATED\", <2>\n \"at\" : \"2017-01-04T18:08:16.600Z\",\n \"last_allocation_status\" : \"no\"\n },\n \"can_allocate\" : \"no\", <3>\n \"allocate_explanation\" : \"Elasticsearch isn't allowed to allocate this shard to any of the nodes in the cluster. Choose a node to which you expect this shard to be allocated, find this node in the node-by-node explanation, and address the reasons which prevent Elasticsearch from allocating this shard there.\",\n \"node_allocation_decisions\" : [\n {\n \"node_id\" : \"8qt2rY-pT6KNZB3-hGfLnw\",\n \"node_name\" : \"node-0\",\n \"transport_address\" : \"127.0.0.1:9401\",\n \"roles\" : [\"data\", \"data_cold\", \"data_content\", \"data_frozen\", \"data_hot\", \"data_warm\", \"ingest\", \"master\", \"ml\", \"remote_cluster_client\", \"transform\"],\n \"node_attributes\" : {},\n \"node_decision\" : \"no\", <4>\n \"weight_ranking\" : 1,\n \"deciders\" : [\n {\n \"decider\" : \"filter\", <5>\n \"decision\" : \"NO\",\n \"explanation\" : \"node does not match index setting [index.routing.allocation.include] filters [_name:\\\"nonexistent_node\\\"]\" <6>\n }\n ]\n }\n ]\n}" | ||
| } |
6 changes: 6 additions & 0 deletions
6
.../cluster/allocation_explain/examples/request/clusterAllocationExplainRequestExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "summary": "cluster/allocation-explain.asciidoc:10", | ||
| "method_request": "GET _cluster/allocation/explain", | ||
| "description": "", | ||
| "value": "{\n \"index\": \"my-index-000001\",\n \"shard\": 0,\n \"primary\": false,\n \"current_node\": \"my-node\"\n}" | ||
| } |
6 changes: 6 additions & 0 deletions
6
.../cluster/allocation_explain/examples/request/clusterAllocationExplainRequestExample2.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "summary": "cluster/allocation-explain.asciidoc:101", | ||
| "method_request": "GET _cluster/allocation/explain", | ||
| "description": "", | ||
| "value": "{\n \"index\": \"my-index-000001\",\n \"shard\": 0,\n \"primary\": true\n}" | ||
| } |
5 changes: 5 additions & 0 deletions
5
specification/cluster/health/examples/200_response/clusterHealthResponseExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "summary": "cluster/health.asciidoc:165", | ||
| "description": "", | ||
| "value": "{\n \"cluster_name\" : \"testcluster\",\n \"status\" : \"yellow\",\n \"timed_out\" : false,\n \"number_of_nodes\" : 1,\n \"number_of_data_nodes\" : 1,\n \"active_primary_shards\" : 1,\n \"active_shards\" : 1,\n \"relocating_shards\" : 0,\n \"initializing_shards\" : 0,\n \"unassigned_shards\" : 1,\n \"delayed_unassigned_shards\": 0,\n \"number_of_pending_tasks\" : 0,\n \"number_of_in_flight_fetch\": 0,\n \"task_max_waiting_in_queue_millis\": 0,\n \"active_shards_percent_as_number\": 50.0\n}" | ||
| } |
5 changes: 5 additions & 0 deletions
5
specification/cluster/info/examples/200_response/clusterNodesInfoResponseExample1.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| { | ||
| "summary": "cluster/nodes-info.asciidoc:229", | ||
| "description": "", | ||
| "value": "{\n \"_nodes\": ...\n \"cluster_name\": \"elasticsearch\",\n \"nodes\": {\n \"USpTGYaBSIKbgSUJR2Z9lg\": {\n \"name\": \"node-0\",\n \"transport_address\": \"192.168.17:9300\",\n \"host\": \"node-0.elastic.co\",\n \"ip\": \"192.168.17\",\n \"version\": \"{version}\",\n \"transport_version\": 100000298,\n \"index_version\": 100000074,\n \"component_versions\": {\n \"ml_config_version\": 100000162,\n \"transform_config_version\": 100000096\n },\n \"build_flavor\": \"default\",\n \"build_type\": \"{build_type}\",\n \"build_hash\": \"587409e\",\n \"roles\": [\n \"master\",\n \"data\",\n \"ingest\"\n ],\n \"attributes\": {},\n \"plugins\": [\n {\n \"name\": \"analysis-icu\",\n \"version\": \"{version}\",\n \"description\": \"The ICU Analysis plugin integrates Lucene ICU module into elasticsearch, adding ICU relates analysis components.\",\n \"classname\": \"org.elasticsearch.plugin.analysis.icu.AnalysisICUPlugin\",\n \"has_native_controller\": false\n }\n ],\n \"modules\": [\n {\n \"name\": \"lang-painless\",\n \"version\": \"{version}\",\n \"description\": \"An easy, safe and fast scripting language for Elasticsearch\",\n \"classname\": \"org.elasticsearch.painless.PainlessPlugin\",\n \"has_native_controller\": false\n }\n ]\n }\n }\n}" | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.