调用ListInstanceSpecs获取集群可选择的规格列表_智能开放搜索 OpenSearch(Open Search)-阿里云帮助中心

获取集群可选择的规格列表。

接口说明

方法

GET

URI

/openapi/ha3/instances/{instanceId}/specs?type=qrs

调试

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

调试

授权信息

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

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

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

请求语法

GET /openapi/ha3/instances/{instanceId}/specs

请求参数

名称	类型	必填	描述	示例值
instanceId	string	是	实例 id	ha-cn-2r42ostoc01
type	string	是	节点类型 (qrs: 查询节点, search: 数据节点, index: 索引节点, cluster: 集群)	search

请求示例

GET /openapi/ha3/instances/ha3_instance_name/specs

返回参数

名称	类型	描述	示例值
	object
requestId	string	id of request	10D5E615-69F7-5F49-B850-00169ADE513C
result	object []	List
cpu	integer	单位：核数	1
mem	integer	单位 G	4
minDisk	integer	单数据节点存储空间最小值
maxDisk	integer	单数据节点存储空间最大值

返回示例

{
  "requestId": "e1eef569-1ff7-4bf8-acf7-1cecca9894ce",
  "result": [
    {
      "cpu": 1
      "mem": 2,
      "disk": 100
    },
    {
      "cpu": 2
      "mem": 4,
      "disk": 100      
    }    
  ]
}

示例

正常返回示例

JSON格式

{
  "requestId": "10D5E615-69F7-5F49-B850-00169ADE513C",
  "result": [
    {
      "cpu": 1,
      "mem": 4,
      "minDisk": 0,
      "maxDisk": 0
    }
  ]
}

错误码

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

变更历史

变更时间

变更内容概要

操作

2023-03-28

OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
出参	OpenAPI 返回结构发生变更。