GetSuggestShrinkableNodes - 获取可缩容节点

更新时间:
复制 MD 格式

指定节点类型和数量,获取可缩容的节点。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

elasticsearch:DescribeInstance

get

*Instance

acs:elasticsearch:{#regionId}:{#accountId}:instances/{#InstanceId}

无 无

请求语法

GET /openapi/instances/{InstanceId}/suggest-shrinkable-nodes HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

InstanceId

string

是

实例 ID。

es-cn-nif1q9o8r0008****

请求参数

名称

类型

必填

描述

示例值

nodeType

string

是

需要缩容的节点类型。WORKER 表示热节点,WORKER_WARM表示冷节点。

WORKER

count

integer

是

期望获取可缩容节点的数量。

1

ignoreStatus

boolean

否

是否忽略实例状态,默认为 false。

false

返回参数

名称

类型

描述

示例值

object

RequestId

string

请求 ID。

F99407AB-2FA9-489E-A259-40CF6DCC****

Result

array<object>

返回结果。

object

port

integer

节点的访问端口号。

9200

host

string

节点的 IP 地址。

192.168.**.**

Result 中还包含以下参数。

名称类型示例值描述
nodeTypeStringWORKER节点类型,取值包括:MASTER(专有主节点)、WORKER(热节点)、WORKER_WARM(冷节点)、COORDINATING(协调节点)、KIBANA(Kibana 节点)。
zoneIdStringcn-hangzhou-b节点所在的可用区 ID。

示例

正常返回示例

JSON格式

{
  "RequestId": "F99407AB-2FA9-489E-A259-40CF6DCC****",
  "Result": [
    {
      "port": 9200,
      "host": "192.168.**.**"
    }
  ]
}

错误码

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

变更历史

更多信息,参考变更详情。