CreateCluster - OpenSearch - Alibaba Cloud Documentation Center

Creates a cluster.

Operation description

Method

POST

URI

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

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
searchengine:CreateCluster	create	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	none	none

Request syntax

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

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