Skip to content

Commit f1cadd9

Browse files
szabostevelcawl
szabosteve
and
lcawl
authored
Adds autoscaling and CCR API request and response examples (#2788)
Co-authored-by: Lisa Cawley <[email protected]>
1 parent d7c8eb5 commit f1cadd9

File tree

26 files changed

+182
-0
lines changed

26 files changed

+182
-0
lines changed

‎specification/autoscaling/delete_autoscaling_policy/autoscalingApisDeleteAutoscalingPolicyResponseExample1.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"summary": "A successful response of deleting one or more autoscaling policy.",
3+
"description": "This may be a respons to either `DELETE /_autoscaling/policy/my_autoscaling_policy` or `DELETE /_autoscaling/policy/*`.",
4+
"type": "response",
5+
"response_code": 200,
6+
"value": "{\n \"acknowledged\": true\n}"
7+
}

‎specification/autoscaling/get_autoscaling_capacity/autoscalingApisGetAutoscalingCapacityResponseExample1.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"summary": "A successful response for retrieving the current autoscaling capacity.",
3+
"description": "This may be a response to `GET /_autoscaling/capacity`.",
4+
"type": "response",
5+
"response_code": 200,
6+
"value": "{\n policies: {}\n}"
7+
}

‎specification/autoscaling/get_autoscaling_policy/autoscalingApisGetAutoscalingPolicyResponseExample1.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"summary": "A successful response for retrieving an autoscaling policy.",
3+
"description": "This may be a response to `GET /_autoscaling/policy/my_autoscaling_policy`.",
4+
"type": "response",
5+
"response_code": 200,
6+
"value": "{\n \"roles\": <roles>,\n \"deciders\": <deciders>\n}"
7+
}

‎specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample1.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"summary": "Creates or updates an autoscaling policy.",
3+
"method_request": "PUT /_autoscaling/policy/<name>",
4+
"description": "",
5+
"type": "request",
6+
"value": "{\n \"roles\": [],\n \"deciders\": {\n \"fixed\": {\n }\n }\n}"
7+
}

‎specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyRequestExample2.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"summary": "Creates an autoscaling policy.",
3+
"method_request": "PUT /_autoscaling/policy/my_autoscaling_policy",
4+
"description": "The API method and path for this request: `PUT /_autoscaling/policy/my_autoscaling_policy`. It creates `my_autoscaling_policy` using the fixed autoscaling decider, applying to the set of nodes having (only) the `data_hot` role.",
5+
"type": "request",
6+
"value": "{\n \"roles\" : [ \"data_hot\" ],\n \"deciders\": {\n \"fixed\": {\n }\n }\n}"
7+
}

‎specification/autoscaling/put_autoscaling_policy/autoscalingApisPutAutoscalingPolicyResponseExample1.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"summary": "A successful response when creating an autoscaling policy.",
3+
"description": "",
4+
"type": "response",
5+
"response_code": 200,
6+
"value": "{\n \"acknowledged\": true\n}"
7+
}

‎specification/ccr/delete_auto_follow_pattern/ccrApisAutoFollowDeleteAutoFollowPatternResponseExample1.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"summary": "A successful response for deleting an auto-follow pattern.",
3+
"description": "",
4+
"type": "response",
5+
"response_code": 200,
6+
"value": "{\n \"acknowledged\" : true\n}"
7+
}

‎specification/ccr/follow/ccrApisFollowPutFollowRequestExample1.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"summary": "Creates a follower index.",
3+
"method_request": "PUT /<follower_index>/_ccr/follow?wait_for_active_shards=1",
4+
"description": "The API method and path for this request: `PUT /<follower_index>/_ccr/follow?wait_for_active_shards=1`.",
5+
"type": "request",
6+
"value": "{\n \"remote_cluster\" : \"<remote_cluster>\",\n \"leader_index\" : \"<leader_index>\"\n}"
7+
}

‎specification/ccr/follow/ccrApisFollowPutFollowRequestExample3.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"summary": "Creates a follower index named `follower_index`.",
3+
"method_request": "PUT /follower_index/_ccr/follow?wait_for_active_shards=1",
4+
"description": "The API method and path for this reqest: `PUT /follower_index/_ccr/follow?wait_for_active_shards=1`.",
5+
"type": "request",
6+
"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}"
7+
}

‎specification/ccr/follow/ccrApisFollowPutFollowResponseExample1.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"summary": "A successful response for creating a follower index.",
3+
"description": "",
4+
"type": "response",
5+
"response_code": 200,
6+
"value": "{\n \"follow_index_created\" : true,\n \"follow_index_shards_acked\" : true,\n \"index_following_started\" : true\n}"
7+
}

0 commit comments

Comments
 (0)