文档

TriggerNetwork

调用TriggerNetwork,开启或关闭Elasticsearch或Kibana集群的公网或私网访问。

由于网络架构升级,云原生架构实例请调用EnableKibanaPvlNetwork开启Kibana私网连接,调用DisableKibanaPvlNetwork关闭kibana私网连接。

调试

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

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

POST /openapi/instances/{InstanceId}/actions/network-trigger HTTP/1.1

请求参数

名称

类型

位置

是否必选

示例值

描述

InstanceId String Path es-cn-n6w1o1x0w001c****

实例ID。

clientToken String Query 407d02b74c49beb5bfdac7ec8bde2488

用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大不超过64个ASCII字符。

Object Body

请求体参数。

nodeType String Body KIBANA

实例类型。可选值:

  • KIBANA:Kibana集群
  • WORKER:Elasticsearch集群
networkType String Body PUBLIC

网络类型。可选值:

  • PUBLIC:公网
  • PRIVATE:私网
actionType String Body OPEN

动作类型。可选值:

  • CLOSE:关闭
  • OPEN:开启

返回数据

名称

类型

示例值

描述

Result Boolean true

返回结果:

  • true:操作成功
  • false:操作失败
RequestId String 5A5D8E74-565C-43DC-B031-29289FA****

请求ID。

示例

请求示例

POST /openapi/instances/es-cn-n6w1o1x0w001c****/actions/network-trigger?clientToken=407d02b74c49beb5bfdac7ec8bde2488 HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json

{
  "nodeType" : "KIBANA",
  "networkType" : "PUBLIC",
  "actionType" : "OPEN"
}

正常返回示例

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Result" : true,
  "RequestId" : "5A5D8E74-565C-43DC-B031-29289F****"
}

错误码

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

  • 本页导读 (1)