ValidateConnection_Elasticsearch_API文档-阿里云OpenAPI开发者门户

接口说明

说明开启 Logstash 的 X-Pack 监控需配置 Elasticsearch 实例。配置后，即可在对应 Elasticsearch 实例的 Kibana 中监控 Logstash 实例。

当前云产品API请求速率暂未透出。

如下是此API对应的授权信息，用于RAM权限策略语句的Action元素中，为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置，使用方法可参考访问控制帮助文档。

具体说明如下：展开详情

操作	访问级别	资源类型	条件关键字	关联操作

elasticsearch:ValidateConnection	Get	Logstash acs:elasticsearch:{#regionId}:{#accountId}:logstashes/{#InstanceId}	无	无

POST /openapi/logstashes/{InstanceId}/validate-connection HTTP/1.1

字段名称	字段详情
InstanceIdstring	Logstash 实例 ID。示例值:ls-cn-oew1qbgl****参考取值来源: ListInstance

字段名称	字段详情
ClientTokenstring	用于保证请求的幂等性。由客户端生成该参数值，要保证在不同请求间唯一，最大不超过 64 个 ASCII 字符。示例值:5A2CFF0E-5718-45B5-9D4D-70B3FF****
bodystring	指定需要连通的 Elasticsearch 实例的信息。示例值:{ "endpoints": [ "http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200" ], "userName": "elastic", "password": "xxxx" }

RequestBody 中还可以填入以下参数，用来指定重启参数信息。

名称	类型	是否必选	示例值	描述
endpoints	List	是	["http://es-cn-n6w1o1x0w001c****.elasticsearch.aliyuncs.com:9200"]	提供 X-Pack 监控的 Elasticsearch 实例的访问地址。
userName	String	是	elastic	Elasticsearch 实例的用户名。
password	String	是	xxx	Elasticsearch 实例的密码。

restartType 为 instance 时，忽略 blueGreenDep 参数。
- force 为 true，batch 必须大于 0，小于等于 100，否则系统会提示 RestartBatchValueError 的报错。
- force 为 false，batch 默认为 0，输入其他值时，会报错 NormalRestartNotSupportBatch。
restartType 为 nodeIp 时，忽略 batch 参数。
- nodeIp 为空，系统会提示参数错误。
- blueGreenDep 为 true，进行蓝绿变更重启；为 false，正常重启。示例如下。

{
    "restartType":"nodeIp",
    "nodes": ["172.16.xx.xx"],
    "blueGreenDep":true
}

字段名称	字段详情
Resultboolean	返回结果：展开详情示例值:true
RequestIdstring	请求 ID。示例值:5FFD9ED4-C2EC-4E89-B22B-1ACB6FE1D***

	变更时间	变更内容概要	操作
	2022-08-30	删除错误码400 删除错误码401