CreateCluster - 添加集群 - 智能开放搜索 OpenSearch

添加集群。

接口说明

方法

POST

URI

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

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
searchengine:CreateCluster	create	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}	无	无

请求语法

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

请求参数

名称	类型	必填	描述	示例值
instanceId	string	是	实例 id	ha-cn-pl32rf0****
body	object	否	请求体参数
name	string	否	集群名称	hz_pre_vpc_domain_1
description	string	否	集群描述。	自定义描述
queryNode	object	否	查询节点详情信息
number	integer	否	查询节点数量	2
dataNode	object	否	数据节点详情信息
number	integer	否	数据节点的数量	2
partition	string	否	分片数	2
autoLoad	boolean	否	是否自动挂载	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
}

返回参数

名称	类型	描述	示例值
	object
requestId	string	请求 ID。	10D5E615-69F7-5F49-B850-00169ADE513C
result	object	返回结果。	{}

Sample responses

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

For more information, see Response structure.

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-05-16	API 内部配置变更，不影响调用	查看变更详情
2022-01-12	新增 OpenAPI	查看变更详情