You can call this operation to remove nodes from a specified Elasticsearch instance.

Notice You can only remove hot or warm nodes from a pay-as-you-go Elasticsearch instance. Elasticsearch instances deployed across zones or subscription-based Elasticsearch instances are not supported.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request header

This operation only uses common request headers. For more information, see the Common request parameters topic.

Request syntax

POST /openapi/instances/[InstanceId]/actions/shrink HTTP/1.1

Request parameters

Parameter Type Required Example Description
InstanceId String Yes es-cn-xxx

The ID of the instance.

nodeType String Yes WORKER

The type of nodes that you want to remove. Valid values: WORKER (hot nodes) and WORKER_WARM (warm nodes).

clientToken String No 5A2CFF0E-5718-45B5-9D4D-70B3FF****

A unique token generated by the client to guarantee the idempotency of the request. The maximum length of the token is 64 ASCII characters.

You must specify request body parameters. For more information, see Sample requests.

Response parameters

Parameter Type Example Description
RequestId String F99407AB-2FA9-489E-A259-40CF6DCC****

The ID of the request.

Result Boolean true

If the specified nodes are removed, value true is returned.

Examples

Sample requests

POST /openapi/instances/[InstanceId]/actions/shrink HTTP/1.1
Common request header
{
  "InstanceId": "es-cn-xxx"
  "nodeType": "WORKER"
}

Request body

Sample request body:
[
	{
		"host": "192.168. **.**",
		"port": 9300
	},
	{
		"host": "192.168. **.**",
		"port": 9300
	}
]

Sample success responses

XML format

<Result>true</Result>
<RequestId>C82758DD-282F-4D48-934F-92170A33****</RequestId>

JSON format

{
	"Result":true,
	"RequestId":"C82758DD-282F-4D48-934F-92170A33****"
}

Error codes

For a list of error codes, visit the API Error Center.