CreateCluster - OpenSearch - Alibaba Cloud Documentation Center

Creates a cluster.

Operation description

Method

POST

URI

/openapi/ha3/instances/{instanceId}/clusters

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

POST /openapi/ha3/instances/{instanceId}/clusters

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-0ju2k3qer02
body	object	No	The request body.
name	string	No	The cluster name.	ha-cn-zvp2qr1sk01_qrs
description	string	No	The description of the cluster.	"ha-tets"
queryNode	object	No	The details of the Query Result Searcher (QRS) workers.
number	integer	No	The number of QRS workers.	2
dataNode	object	No	The details of the Searcher workers.
number	integer	No	The number of Searcher workers.	2
partition	string	No	The number of shards.	2
autoLoad	boolean	No	Specifies whether to enable automatic connection.	true

Sample requests

POST/openapi/ha3/instances/ha3_instance_id/clusters

{
  "name":"cluster1",
  "queryNode": {
    "number": 1
  },
  "dataNode": {
    "number": 2
  },
  "description":"The description of the cluster",
  "autoLoad":true
}

Response parameters

Parameter	Type	Description	Example
	object	The results returned.
requestId	string	The request ID.	10D5E615-69F7-5F49-B850-00169ADE513C
result	object	The result.	{}

Sample responses

{
  "requestId": "0A6EB64B-B4C8-CF02-810F-E660812972FF",
  "result": []
}

Examples

Sample success responses

JSONformat

{
  "requestId": "10D5E615-69F7-5F49-B850-00169ADE513C",
  "result": {}
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-05-16	The internal configuration of the API is changed, but the call is not affected	View Change Details
2022-01-12	Add Operation	View Change Details